Global API

Requests

3min

Request Types

Below are the supported actions which can be processed using Breadwinner for NetSuite Global API.

For each object below, prepend the object name with the supported operation to get the method name. For example, to read a customer, you would use the action readCustomer.



read

create

update

Customer

Y

Y

Y

CustomerSubsidiaryRelationship

Y

Y

N/A

Item

Y

Y

N/A

Vendor

Y

Y

Y

Contact

Y

Y

Y

Estimate

Y

Y

Y

SalesOrder

Y

Y

Y

Invoice

Y

Y

Y

CashSale

Y

Y

Y

CustomerPayment

Y

Y

Y

ReturnAuthorization (RMA)

Y

Y

Y

CashRefund

Y

Y

Y

CreditMemo

Y

Y

Y

PurchaseOrder

Y

Y

Y

VendorBill

Y

Y

Y

CustomObjectRecord

Y

Y

Y

Building Requests

Breadwinner accepts requests in the form of a Map<String, Object>.

These are the supported keys:

Key (String)

Value (Object)

Required

version

'1.0'

True

action

See the list of available actions.

True

skipDML

Defaults to FALSE if not provided. When set to true, the record will not be saved in Salesforce in that transaction, only get saved to NetSuite.

False

updateSF

Defaults to FALSE if it is not provided in the request. It will be applicable only for read operations. When it is set to true, the record will be updated in Salesforce.

False

requestJSON

Pass the data as a JSON string based on the specified action.

True

fromSalesforceSites

Defaults to FALSE if it is not provided in the request. It will be applicable only for requests performed from salesforce site's guest users

False

Examples

See the related objects in the left menu for examples.

Updated 15 Oct 2024
Doc contributor
Doc contributor
Doc contributor
Doc contributor
Doc contributor
Doc contributor
Did this page help you?