netsuite
Module netsuite
API
Declarations
Definitions
ballerinax/netsuite Ballerina library
Overview
NetSuite's SuiteTalk SOAP API provides the capability to access NetSuite operations related to different kinds of NetSuite records such as Account, Client, Transactions, Invoice, Classifications etc.
This module supports NetSuite WSDL 2020.2.0 version.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create a NetSuite account
- Obtain tokens tokens
-
Go to NetSuite and sign in to your account.
-
If you have NetSuite permission to create an integration application, the following steps may be helpful. If not, proceed to step 3.
-
Enable the SuiteTalk Web service features of the account (Setup->Company->Enable Features).
-
Create an integration application (Setup->Integration->New), enable TBA code grant and scope, and obtain the following credentials:
- Client ID
- Client secret
-
-
If you have client ID, client secret from your administrator, obtain the credentials below by following the token based authorization in the NetSuite documentation.
- Access token
- Access token Secret
-
Obtain the SuitTalk Base URL that contains the account ID under the company URLs (Setup->Company->Company Information).
e.g., https://<ACCOUNT_ID>.suitetalk.api.netsuite.com
-
Quickstart
To use the NetSuite connector in your Ballerina application, update the .bal file as follows:
Step 1 - Import connector
- Create a Ballerina file and import the following Netsuite module.
import ballerinax/netsuite;
Step 2 - Create a new connector instance
- Create a NetSuite client by providing credentials. Initialize the connector by giving authentication details in the HTTP client configuration, which has built-in support for Token Based Authentication(TBA). The NetSuite connector can be initialized by the HTTP client configuration using the client ID, client secret, access token, and the access token secret. You can use the Ballerina Configuration variable to store your credentials.
public function main() returns error? { netsuite:NetsuiteConfiguration nsConfig = { accountId: "<accountId>", consumerId: "<consumerId>", consumerSecret: "<consumerSecret>", token: "<token>", tokenSecret: "<tokenSecret>", baseURL: "<webServiceURL>" }; netsuite:Client netsuiteClient = check new(nsConfig);
Step 3 - Invoke connector operation
- Invoke the connector operation using the client.
netsuite:RecordInputRef currency = { internalId: "1", 'type: "currency" }; netsuite:NewAccount account = { acctNumber: "1234567", acctName: "Ballerina NetSuite Demo Account", currency: currency }; netsuite:RecordAddResponse newAccount = check netsuiteClient->addNewAccount(account);
- Use
bal run
command to compile and run the Ballerina program.
Clients
netsuite: Client
NetSuite's SuiteTalk SOAP API provides capability to access NetSuite operations related different kind of NetSuite records such as Account, Client, Transactions, Invoice, Classifications etc.
Constructor
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials.
This connector supports NetSuite Token Based Authentication.
Follow this guide
to Obtain token for NetSuite connector configuration.
init (NetSuiteConfiguration config)
- config NetSuiteConfiguration - NetSuite connection configuration
addNewCustomer
function addNewCustomer(NewCustomer customer) returns RecordAddResponse|error
Creates a record instance in NetSuite according to the given detail
Parameters
- customer NewCustomer - Details of NetSuite record instance creation
Return Type
- RecordAddResponse|error - RecordAddResponse type record or else the relevant error
addNewContact
function addNewContact(NewContact contact) returns RecordAddResponse|error
Creates a record instance in NetSuite according to the given detail
Parameters
- contact NewContact - Details of NetSuite record instance creation
Return Type
- RecordAddResponse|error - RecordAddResponse type record or else the relevant error
addNewInvoice
function addNewInvoice(NewInvoice invoice) returns RecordAddResponse|error
Creates a record instance in NetSuite according to the given detail
Parameters
- invoice NewInvoice - Invoice type record with detail
Return Type
- RecordAddResponse|error - RecordAddResponse type record otherwise the relevant error
addNewCurrency
function addNewCurrency(NewCurrency currency) returns RecordAddResponse|error
Creates a record instance in NetSuite according to the given detail
Parameters
- currency NewCurrency - Currency type record with detail
Return Type
- RecordAddResponse|error - RecordAddResponse type record otherwise the relevant error
addNewSalesOrder
function addNewSalesOrder(NewSalesOrder salesOrder) returns RecordAddResponse|error
Creates a record instance in NetSuite according to the given detail
Parameters
- salesOrder NewSalesOrder - SalesOrder type record with detail
Return Type
- RecordAddResponse|error - RecordAddResponse type record otherwise the relevant error
addNewClassification
function addNewClassification(NewClassification classification) returns RecordAddResponse|error
Creates a record instance in NetSuite according to the given detail
Parameters
- classification NewClassification - Classification type record with detail
Return Type
- RecordAddResponse|error - RecordAddResponse type record otherwise the relevant error
addNewAccount
function addNewAccount(NewAccount account) returns RecordAddResponse|error
Creates a record instance in NetSuite according to the given detail
Parameters
- account NewAccount - Account type record with detail
Return Type
- RecordAddResponse|error - RecordAddResponse type record otherwise the relevant error
deleteRecord
function deleteRecord(RecordDetail info) returns RecordDeletionResponse|error
Deletes a record instance from NetSuite according to the given detail if they are valid.
Parameters
- info RecordDetail - Details of NetSuite record instance to be deleted
Return Type
- RecordDeletionResponse|error - RecordDeletionResponse type record otherwise the relevant error
updateCustomerRecord
function updateCustomerRecord(Customer customer) returns RecordUpdateResponse|error
Updates a NetSuite customer instance by internal ID
Parameters
- customer Customer - Customer record with details and internal ID
Return Type
- RecordUpdateResponse|error - RecordUpdateResponse type record otherwise the relevant error
updateContactRecord
function updateContactRecord(Contact contact) returns RecordUpdateResponse|error
Updates a NetSuite contact instance by internal ID
Parameters
- contact Contact - Contact record with details and internal ID
Return Type
- RecordUpdateResponse|error - RecordUpdateResponse type record otherwise the relevant error
updateCurrencyRecord
function updateCurrencyRecord(Currency currency) returns RecordUpdateResponse|error
Updates a NetSuite currency instance by internal ID
Parameters
- currency Currency - Currency record with details and internal ID
Return Type
- RecordUpdateResponse|error - RecordUpdateResponse type record otherwise the relevant error
updateInvoiceRecord
function updateInvoiceRecord(Invoice invoice) returns RecordUpdateResponse|error
Updates a NetSuite invoice instance by internal ID
Parameters
- invoice Invoice - Invoice record with details and internalId
Return Type
- RecordUpdateResponse|error - RecordUpdateResponse type record otherwise the relevant error
updateSalesOrderRecord
function updateSalesOrderRecord(SalesOrder salesOrder) returns RecordUpdateResponse|error
Updates a NetSuite salesOrder instance by internal ID
Parameters
- salesOrder SalesOrder - SalesOrder record with details and internalId
Return Type
- RecordUpdateResponse|error - RecordUpdateResponse type record otherwise the relevant error
updateClassificationRecord
function updateClassificationRecord(Classification classification) returns RecordUpdateResponse|error
Updates a NetSuite classification instance by internal ID
Parameters
- classification Classification - Classification record with details and internalId
Return Type
- RecordUpdateResponse|error - RecordUpdateResponse type record otherwise the relevant error
updateAccountRecord
function updateAccountRecord(Account account) returns RecordUpdateResponse|error
Updates a NetSuite account instance by internal ID
Parameters
- account Account - Account record with details and internal ID
Return Type
- RecordUpdateResponse|error - RecordUpdateResponse type record otherwise the relevant error
getAllCurrencyRecords
Retrieves all currency types instances from NetSuite.
Return Type
searchCustomerRecords
function searchCustomerRecords(SearchElement[] searchElements) returns stream<Customer, error>|error
Retrieves NetSuite client instances from NetSuite according to the given detail if they are valid.
Parameters
- searchElements SearchElement[] - Details of a NetSuite record to be retrieved from NetSuite
searchTransactionRecords
function searchTransactionRecords(SearchElement[] searchElements) returns stream<RecordRef, error>|error
Retrieves NetSuite transaction instances from NetSuite according to the given detail if they are valid.
Parameters
- searchElements SearchElement[] - Details of a NetSuite record to be retrieved from NetSuite
searchAccountRecords
function searchAccountRecords(SearchElement[] searchElements) returns stream<Account, error>|error
Retrieves NetSuite account record instances from NetSuite according to the given detail.
Parameters
- searchElements SearchElement[] - Details of a NetSuite record to be retrieved from NetSuite
searchContactRecords
function searchContactRecords(SearchElement[] searchElements) returns stream<Contact, error>|error
Retrieves NetSuite contact record instances from NetSuite according to the given detail
Parameters
- searchElements SearchElement[] - Details of a NetSuite record to be retrieved from NetSuite
getCustomerRecord
function getCustomerRecord(RecordInfo recordInfo) returns Customer|error
Gets a customer record from Netsuite by using internal ID.
Parameters
- recordInfo RecordInfo - Ballerina record for Netsuite record information
getContactRecord
function getContactRecord(RecordInfo recordInfo) returns Contact|error
Gets a contact record from Netsuite by using internal ID.
Parameters
- recordInfo RecordInfo - Ballerina record for Netsuite record information
getCurrencyRecord
function getCurrencyRecord(RecordInfo recordInfo) returns Currency|error
Gets a currency record from Netsuite by using internal ID.
Parameters
- recordInfo RecordInfo - Ballerina record for Netsuite record information
getClassificationRecord
function getClassificationRecord(RecordInfo recordInfo) returns Classification|error
Gets a currency record from Netsuite by using internal ID.
Parameters
- recordInfo RecordInfo - Ballerina record for Netsuite record information
Return Type
- Classification|error - Classification type record otherwise the relevant error
getInvoiceRecord
function getInvoiceRecord(RecordInfo recordInfo) returns Invoice|error
Gets a invoice record from Netsuite by using internal ID.
Parameters
- recordInfo RecordInfo - Ballerina record for Netsuite record information
getSalesOrderRecord
function getSalesOrderRecord(RecordInfo recordInfo) returns SalesOrder|error
Gets a salesOrder record from Netsuite by using internal ID.
Parameters
- recordInfo RecordInfo - Ballerina record for Netsuite record information
Return Type
- SalesOrder|error - SalesOrder type record otherwise the relevant error
getAccountRecord
function getAccountRecord(RecordInfo recordInfo) returns Account|error
Gets a account record from Netsuite by using internal Id.
Parameters
- recordInfo RecordInfo - Ballerina record for Netsuite record information
getNetSuiteServerTime
Returns the NetSuite server time in GMT, regardless of a user's time zone.
Constants
netsuite: DEFAULT_ZERO_VALUE
Enums
netsuite: AccountType
Members
netsuite: BasicSearchOperator
Members
netsuite: ConsolidatedRate
Members
netsuite: Country
Members
netsuite: GlobalSubscriptionStatusType
Members
netsuite: RecordCoreType
Members
netsuite: RecordGetAllType
Members
netsuite: RecordSaveSearchType
Members
netsuite: SalesOrderStatus
Members
netsuite: SearchType
Members
netsuite: TransactionType
Members
Records
netsuite: Account
NetSuite Account type record
Fields
- internalId string - Internal ID
- externalId string? - External ID
- acctNumber string? - Account Number
- acctName string? - Account Name
- legalName string? - Legal Name of the Account
- currency RecordRef? - Account currency
- Fields Included from * AccountCommon
- acctType ballerinax/netsuite:1.0.1:AccountType|string
- unitsType RecordRef
- unit RecordRef
- includeChildren boolean
- exchangeRate string
- generalRate string
- cashFlowRate ballerinax/netsuite:1.0.1:ConsolidatedRate|string
- billableExpensesAcct RecordRef
- deferralAcct RecordRef
- description string
- curDocNum decimal
- isInactive boolean
- department RecordRef
- class RecordRef
- location RecordRef
- inventory boolean
- eliminate boolean
- openingBalance decimal
- revalue boolean
- subsidiary Subsidiary
netsuite: Address
Represents an address record in NetSuite
Fields
- internalId string? - Netsuite Internal ID
- attention string? - Field Description
- addressee string? - addressee of this record
- addrPhone string? - Address phone
- addr1 string? - Address Part01
- addr2 string? - Address Part02
- addr3 string? - Address Part03
- city string? - City of the Address
- state string? - State of the Address
- zip string? - Zip code the area
- addrText string? - Address stress
- override boolean? - override the existing address
netsuite: Category
NetSuite category type record
Fields
- Fields Included from * RecordRef
netsuite: Classification
Netsuite Classification type record
Fields
- internalId string - Internal ID
- name string? - Name of the classification
- parent RecordRef? - References parent classifications
- includeChildren boolean? - Checks for child classifications
- Fields Included from * ClassificationCommon
netsuite: Contact
Netsuite Contact type record
Fields
- internalId string - internal ID of the record
- salutation string? - The contact's salutation
- firstName string? - First name of the contact
- Fields Included from * ContactCommon
- middleName string
- lastName string
- entityId string
- title string
- phone string
- fax string
- email string
- defaultAddress string
- isPrivate boolean
- isInactive boolean
- altEmail string
- officePhone string
- homePhone string
- mobilePhone string
- supervisorPhone string
- assistantPhone string
- comments string
- image string
- billPay boolean
- dateCreated string
- lastModifiedDate string
- addressBookList ballerinax/netsuite:1.0.1:ContactAddressBook[]
- SubscriptionsList ballerinax/netsuite:1.0.1:Subscription[]
- assistant RecordRef
- supervisor RecordRef
- contactSource RecordRef
- company RecordRef
- customForm RecordRef
- subsidiary RecordRef? - The subsidiary to associate with this contact
netsuite: ContactAddressBook
NeSuite contactAddressBook type record
Fields
- defaultShipping boolean? - default shipping address
- defaultBilling boolean? - default billing address
- label string? - contactBookLabel
- addressBookAddress Address[]? - AddressBook address
- internalId string? - InternalID of the record
netsuite: Currency
Netsuite Currency type record
Fields
- internalId string - Internal ID of the currency record
- name string? - Name of the record
- symbol string? - Symbol of the record
- exchangeRate decimal? - The exchange rate of the currency
- Fields Included from * CurrencyCommon
netsuite: Customer
Netsuite Customer type record
Fields
- internalId string - Internal ID of the customer record
- Fields Included from * CustomerCommon
- salutation string
- firstName string
- middleName string
- lastName string
- phone string
- fax string
- email string
- defaultAddress string
- title string
- homePhone string
- mobilePhone string
- accountNumber string
- entityId string
- isInactive boolean
- isPerson boolean
- category RecordRef
- addressbookList ballerinax/netsuite:1.0.1:CustomerAddressbook[]
- currencyList ballerinax/netsuite:1.0.1:CustomerCurrency[]
- companyName string? - Company name
- subsidiary RecordRef? - Selects the subsidiary to associate with this entity or job
netsuite: CustomerAddressbook
Netsuite CustomerAddressbook type record
Fields
- Fields Included from * ContactAddressBook
- isResidential boolean - Whether addressBook is residential or not
netsuite: CustomerCurrency
NetSuite CustomerCurrency type record
Fields
- currency RecordRef? - The NetSuite currency
- balance decimal? - balance of the customerCurrency
- consolBalance decimal? - Consolidated balance
- depositBalance decimal? - Deposit Balance
- consolDepositBalance decimal? - Consolidated Deposit
- overdueBalance decimal? - OverDue Balance
- consolOverdueBalance decimal? - Consolidated overdue balance
- unbilledOrders decimal? - Unbilled orders
- consolUnbilledOrders decimal? - Consolidated unbilled orders
- overrideCurrencyFormat boolean? - checks whether override the currency format
netsuite: Invoice
Represents a NetSuite Invoice record
Fields
- internalId string - The internalId of the invoice
- entity RecordRef? - The customer of the invoice
- itemList Item[]? - The item list for the invoice
- invoiceId string? - The ID of the invoice
- Fields Included from * InvoiceCommon
netsuite: InvoiceCommon
Represents a NetSuite Invoice record
Fields
- recognizedRevenue decimal? - Recognized Revenue: cumulative amount of revenue recognized for this transaction
- discountTotal decimal? - The amount discounted on this invoice
- deferredRevenue decimal? - The amount of revenue deferred on this transaction
- total decimal? - The total of line items, tax and shipping costs
- email string? - References an email for the invoice
- createdDate string? - Created date of the invoice
- lastModifiedDate string? - The last modified Date of the invoice
- status string? - The status of the Invoice
- classification Classification? - The classification of the invoice
- currency RecordRef? - The currency of the invoice
- 'class RecordRef? - The class of the invoice
- department RecordRef? - A department to associate with this invoice
- subsidiary RecordRef? - The subsidiary of the invoice
netsuite: Item
NetSuite general Item record
Fields
- subscription RecordRef? - Subscription of salesOrderItem
- item RecordRef - References an item type record
- quantityAvailable decimal? - The available quantity
- quantityOnHand decimal? - Sets the quantity on hand for this item
- quantity decimal? - Quantity of the item
- units RecordRef? - Number of item units
- description string? - Item description
- price RecordRef? - Price of the item
- rate string? - Defines the rate for this item.
- amount decimal - Amount of the item
- isTaxable boolean? - Shows whether item is taxable
- location RecordRef? - Locations for details
netsuite: NetSuiteConfiguration
Configuration record for NetSuite.
Fields
- accountId string - NetSuite Account ID
- consumerId string - Netsuite Integration App consumer ID
- consumerSecret string - Netsuite Integration application consumer secret
- token string - Netsuite user role access token
- tokenSecret string - Netsuite user role access secret
- baseURL string - Netsuite SuiteTalk URLs for SOAP web services (Available at Setup->Company->Company Information->Company URLs)
netsuite: NewAccount
NetSuite Account type record
Fields
- acctNumber string - Account Number
- acctName string - Account Name
- currency RecordInputRef? - Account Currency Detail(Type: netsuite:CURRENCY)
- Fields Included from * AccountCommon
- acctType ballerinax/netsuite:1.0.1:AccountType|string
- unitsType RecordRef
- unit RecordRef
- includeChildren boolean
- exchangeRate string
- generalRate string
- cashFlowRate ballerinax/netsuite:1.0.1:ConsolidatedRate|string
- billableExpensesAcct RecordRef
- deferralAcct RecordRef
- description string
- curDocNum decimal
- isInactive boolean
- department RecordRef
- class RecordRef
- location RecordRef
- inventory boolean
- eliminate boolean
- openingBalance decimal
- revalue boolean
- subsidiary Subsidiary
netsuite: NewClassification
Netsuite Classification type record
Fields
- name string - Name of the classification
- parent RecordInputRef? - References parent classifications
- Fields Included from * ClassificationCommon
netsuite: NewContact
Netsuite Contact type record
Fields
- firstName string - First name of the contact
- subsidiary RecordInputRef - The subsidiary to associate with this contact
- Fields Included from * ContactCommon
- middleName string
- lastName string
- entityId string
- title string
- phone string
- fax string
- email string
- defaultAddress string
- isPrivate boolean
- isInactive boolean
- altEmail string
- officePhone string
- homePhone string
- mobilePhone string
- supervisorPhone string
- assistantPhone string
- comments string
- image string
- billPay boolean
- dateCreated string
- lastModifiedDate string
- addressBookList ballerinax/netsuite:1.0.1:ContactAddressBook[]
- SubscriptionsList ballerinax/netsuite:1.0.1:Subscription[]
- assistant RecordRef
- supervisor RecordRef
- contactSource RecordRef
- company RecordRef
- customForm RecordRef
netsuite: NewCurrency
Netsuite Currency type record
Fields
- name string - Name of the record
- symbol string - Symbol of the record
- exchangeRate decimal - The exchange rate of the currency
- Fields Included from * CurrencyCommon
netsuite: NewCustomer
Netsuite Customer type record
Fields
- companyName string - Company name
- subsidiary RecordInputRef - Selects the subsidiary to associate with this entity or job
- Fields Included from * CustomerCommon
- salutation string
- firstName string
- middleName string
- lastName string
- phone string
- fax string
- email string
- defaultAddress string
- title string
- homePhone string
- mobilePhone string
- accountNumber string
- entityId string
- isInactive boolean
- isPerson boolean
- category RecordRef
- addressbookList ballerinax/netsuite:1.0.1:CustomerAddressbook[]
- currencyList ballerinax/netsuite:1.0.1:CustomerCurrency[]
netsuite: NewInvoice
Represents a NetSuite Invoice record
Fields
- entity RecordInputRef - The customer of the invoice
- itemList Item[] - The item list for the invoice
- Fields Included from * InvoiceCommon
netsuite: NewSalesOrder
Netsuite Sales Order type record
Fields
- entity RecordInputRef - The customer of the sales Order
- itemList Item[] - The list of items
- Fields Included from * SalesOrderCommon
- internalId string
- createdDate string
- tranDate string
- tranId string
- orderStatus ballerinax/netsuite:1.0.1:SalesOrderStatus|string
- nextBill string
- startDate string
- endDate string
- memo string
- excludeCommission boolean
- totalCostEstimate decimal
- estGrossProfit decimal
- estGrossProfitPercent decimal
- exchangeRate decimal
- currencyName string
- isTaxable boolean
- email string
- shipDate string
- subTotal decimal
- discountTotal decimal
- total decimal
- balance decimal
- status string
- billingAddress Address
- shippingAddress Address
- subsidiary RecordRef
- customForm RecordRef
- currency RecordRef
- drAccount RecordRef
- fxAccount RecordRef
- opportunity RecordRef
- salesRep RecordRef
- partner RecordRef
- salesGroup RecordRef
- leadSource RecordRef
- entityTaxRegNum RecordRef
- createdFrom RecordRef
netsuite: RecordAddResponse
Ballerina record for netsuite record creation response
Fields
- isSuccess boolean - Boolean for checking submission NetSuite failures
- afterSubmitFailed boolean? - Boolean for checking After submission NetSuite failures
- internalId string - NetSuite record ID
- recordType string - Netsuite record type
- warning string? - Netsuite warnings
netsuite: RecordBaseRef
Represents record reference base to NetSuite Records
Fields
- internalId string - NetSuite Internal ID
- name string? - Name of the Record
- externalId string? - NetSuite external ID
netsuite: RecordDeletionResponse
Ballerina record for Netsuite record deletion response
Fields
- Fields Included from * RecordAddResponse
netsuite: RecordDetail
Ballerina record for Netsuite record delete response
Fields
- Fields Included from * RecordInfo
- deletionReasonId string? - Reason ID for deletion
- deletionReasonMemo string? - NetSuite Reason memo for deletion
netsuite: RecordInfo
Ballerina record for Netsuite record delete response
Fields
- recordType string - NetSuite Record type Eg: "currency","invoice", netsuite:INVOICE etc.
- recordInternalId string - Internal ID of the Netsuite record
netsuite: RecordInputRef
References to NetSuite Records for Input operations
Fields
- Fields Included from * RecordBaseRef
- 'type string - Type of the Record Eg: "currency" or netsuite:CURRENCY
netsuite: RecordList
Ballerina record for storing search results
Fields
- records RecordRef[] - Array of record references
netsuite: RecordRef
References to NetSuite Records
Fields
- Fields Included from * RecordBaseRef
- 'type string - Type of the Record
netsuite: RecordUpdateResponse
Ballerina record for Netsuite record update response
Fields
- Fields Included from * RecordAddResponse
netsuite: SalesOrder
Netsuite Sales Order type record
Fields
- internalId string - Internal ID of the SalesOrder record
- entity RecordRef? - The customer of the sales Order
- itemList Item[]? - The list of items
- Fields Included from * SalesOrderCommon
- internalId string
- createdDate string
- tranDate string
- tranId string
- orderStatus ballerinax/netsuite:1.0.1:SalesOrderStatus|string
- nextBill string
- startDate string
- endDate string
- memo string
- excludeCommission boolean
- totalCostEstimate decimal
- estGrossProfit decimal
- estGrossProfitPercent decimal
- exchangeRate decimal
- currencyName string
- isTaxable boolean
- email string
- shipDate string
- subTotal decimal
- discountTotal decimal
- total decimal
- balance decimal
- status string
- billingAddress Address
- shippingAddress Address
- subsidiary RecordRef
- customForm RecordRef
- currency RecordRef
- drAccount RecordRef
- fxAccount RecordRef
- opportunity RecordRef
- salesRep RecordRef
- partner RecordRef
- salesGroup RecordRef
- leadSource RecordRef
- entityTaxRegNum RecordRef
- createdFrom RecordRef
netsuite: SalesOrderCommon
Netsuite Sales Order type record
Fields
- internalId string? - InternalId of the salesOrder record in Netsuite
- createdDate string? - created date of the salesOrder record in Netsuite
- tranDate string? - The posting date of this sales order
- tranId string? - Sales Order number
- orderStatus SalesOrderStatus|string? - status of sales orders
- nextBill string? - Date of the next bill
- startDate string? - The date for the first invoice to be created
- endDate string? - The end date of the order
- memo string? - A memo to describe this sales order
- excludeCommission boolean? - Option to exclude this transaction
- totalCostEstimate decimal? - Estimated Cost
- estGrossProfit decimal? - Estimated Gross Profit
- estGrossProfitPercent decimal? - Estimated Gross Profit Margin
- exchangeRate decimal? - The currency's exchange rate
- currencyName string? - Name of the currency
- isTaxable boolean? - A check mark in this box if this order is taxable
- email string? - The email address
- shipDate string? - Type or pick a shipping date for this order
- subTotal decimal? - Total before any discounts, shipping cost, handling cost or tax
- discountTotal decimal? - NetSuite enters the amount discounted on this sales order
- total decimal? - The total of line items, tax and shipping costs
- balance decimal? - The balance owed by this customer
- status string? - Status of the sales Order
- billingAddress Address? - The billing address
- shippingAddress Address? - The shipping address
- subsidiary RecordRef? - Subsidiary of the Sales Order
- customForm RecordRef? - References the customized sales order form
- currency RecordRef? - The currency of the sales Order
- drAccount RecordRef? - Deferred revenue reclassification account
- fxAccount RecordRef? - Foreign currency adjustment revenue account
- opportunity RecordRef? - References an Netsuite Opportunity
- salesRep RecordRef? - The sales representative associated with the company on the customer record
- partner RecordRef? - A partner to associate with this transaction
- salesGroup RecordRef? - A sales team to associate with this transaction
- leadSource RecordRef? - The lead source associated with this transaction
- entityTaxRegNum RecordRef? - The customer's tax registration number associated with this sales order
- createdFrom RecordRef? - The opportunity or estimate used to create this sales order
netsuite: SavedSearchResponse
Netsuite saveSearch list response record
Fields
- numberOfRecords int? - Number of records
- isSuccess boolean - Boolean for checking submission NetSuite failures
- recordRefList RecordRef[](default []) - Netsuite record reference list
netsuite: SearchElement
Ballerina records for search operation
Fields
- fieldName string - Name of the search field (Eg: name, type)
- operator string|BasicSearchOperator - Searching operator (optional for boolean searches)
- searchType SearchType - Netsuite search field type
- value1 string - Primary search value
- value2 string? - Secondary search value
- multiValues string[]? - An array of strings for multi values in case there are more values excepts primary and secondary
netsuite: Subscription
Netsuite Subscription type record
Fields
- subscribed boolean - Subscription ID
- subscription RecordRef - Subscription Detail
- lastModifiedDate string - Last modified date of the subscription
netsuite: Subsidiary
Netsuite Subsidiary type record
Fields
- name string? - Name of the subsidiary
- country string? - Country of the subsidiary
- email string? - Email of the subsidiary
- isElimination boolean? - The elimination status of the subsidiary
- isInactive boolean? - Shows whether subsidiary is active or not
- legalName string? - Legal name of the subsidiary
- url string? - URL for the subsidiary
Union types
netsuite: ExistingRecordType
ExistingRecordType
RecordType Connector supports for update operation for now.
netsuite: NewRecordType
NewRecordType
RecordType Connector supports for creation operation for now.
Import
import ballerinax/netsuite;
Metadata
Released date: over 2 years ago
Version: 1.0.1
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: slbeta2
GraalVM compatible: Yes
Pull count
Total: 4716
Current verison: 2
Weekly downloads
Keywords
NetSuite
Finance
Integration
Contributors
Dependencies