|
void
|
addFields(RecordTypeEnum recordType, DynamicObjectBuilder<?> dynamicObject, DefaultPojoMetaDataModel fieldModel, List<CustomFieldRef> customFields)
|
|
RecordRef
|
addFile(RecordRef folderId, Map<String, Object> attributes, Object content, String fileName, Preferences preferences)
Creates a new file record.
|
|
List<WriteResponse>
|
addList(String recordType, List<Map<String, Object>> records, Preferences preferences)
Used to add one or more records into the system
|
|
BaseRef
|
addRecord(String recordType, Map<String, Object> attributes, Preferences preferences)
|
|
List<WriteResponse>
|
addRecordObjects(List<? extends Record> records)
Creates new records
Example:
|
|
AsyncStatusResult
|
asyncAddList(RecordType recordType, List<Map<String, Object>> recordsAttributes, Preferences preferences)
|
|
AsyncStatusResult
|
asyncDeleteList(List<BaseRefType> records, Preferences preferences)
An asynchronous requests equivalent to #deleteList(Map).
|
|
AsyncStatusResult
|
asyncDeleteListRecords(List<RecordRef> records, Preferences preferences)
An asynchronous requests equivalent to #deleteList(Map).
|
|
AsyncStatusResult
|
asyncGetList(List<BaseRefType> records, Preferences preferences)
An asynchronous requests equivalent to #getList(Map).
|
|
AsyncStatusResult
|
asyncGetListRecords(List<RecordRef> records, Preferences preferences)
An asynchronous requests equivalent to #getList(Map).
|
|
AsyncStatusResult
|
asyncInitializeList(List<InitializeRecord> initializeRecord, Preferences preferences)
An asynchronous requests equivalent to #initializeRecord.
|
|
AsyncStatusResult
|
asyncSearch(SearchRecordTypeEnum recordType, String expression, boolean bodyFieldsOnly, boolean returnSearchColumns, Integer pageSize)
Searches for all records that match the given filtering expression, asynchronously.
|
|
AsyncStatusResult
|
asyncUpdateList(RecordType recordType, List<Map<String, Object>> recordsAttributes, Preferences preferences)
An asynchronous requests equivalent to #updateRecord(Map).
|
|
AsyncStatusResult
|
asyncUpsertList(RecordType recordType, List<Map<String, Object>> recordsAttributes, Preferences preferences)
An asynchronous requests equivalent to #upsertRecord(Map).
|
|
WriteResponse
|
attachRecord(RecordRef source, RecordRef destination, RecordRef contact, RecordRef role, Preferences preferences)
Attaches a source or contact record - that is, the attachment - to another destination one
Not all record type are supported as source, destination or
contact.
|
|
SessionResponse
|
changeEmail(String newEmail, Boolean justThisAccount)
Use to change the email address for the account.
|
|
SessionResponse
|
changePassword(String newPassword, Boolean justThisAccount)
Use to change the password for the account.
|
|
AsyncStatusResult
|
checkAsyncStatus(String jobId, Preferences preferences)
Answers the status of an asynchronous Web services submission.
|
|
void
|
connect(String email, String password, String endpoint, String account, String roleId, Long connectionTimeout, Long receiveTimeout)
Connection Management connect method
|
|
String
|
connectionId()
|
|
WriteResponse
|
delete(BaseRefType baseRef, Preferences preferences)
|
|
List<WriteResponse>
|
deleteList(List<BaseRefType> records, Preferences preferences)
Used to delete one or more records in the system.
|
|
WriteResponse
|
deleteRecord(RecordRef recordRef, Preferences preferences)
|
|
List<WriteResponse>
|
deleteRecordsList(List<RecordRef> records, Preferences preferences)
Used to delete one or more records in the system.
|
|
WriteResponse
|
detachRecord(RecordRef source, RecordRef destination, Preferences preferences)
Detaches a source record - that is, the attachment - from a destination record.
|
|
void
|
disconnect()
Connection Management disconnect method
|
|
Map<String, Object>
|
get(BaseRefType baseRef, Preferences preferences)
This is used to retrieve a record by providing the unique id that identifies that record.
|
|
AsyncResult
|
getAsyncResult(String jobId, Integer pageIndex, Preferences preferences)
Answers the results of an asynchronous web services submission.
|
|
GetBudgetExchangeRateResult
|
getBudgetExchangeRates(RecordRef period, RecordRef fromSubsidiary, RecordRef toSubsidiary, Preferences preferences)
Answers the list of budget exchange rates
Example:
|
|
NetSuiteClient
|
getClient()
|
|
GetConsolidatedExchangeRateResult
|
getConsolidatedExchangeRates(RecordRef period, RecordRef fromSubsidiary, RecordRef toSubsidiary, Preferences preferences)
Answers the list of consolidated exchange rates
Example:
|
|
GetCurrencyRateResult
|
getCurrentRate(CurrencyRateFilter rateFilter, Preferences preferences)
Use this operation to get the exchange rate between two currencies based on a certain date.
|
|
GetCustomizationIdResult
|
getCustomizationIds(GetCustomizationType type, boolean includeInactives, Preferences preferences)
Answers the ids of available customizations for a given record type.
|
|
GetDataCenterUrlsResult
|
getDataCenterUrls(String accountId)
Use for dynamic discovery of data-center-specific URLs for partner applications’ access to NetSuite.
|
|
String
|
getDefaultEndpoint()
|
|
GetDeletedResult
|
getDeletedRecords(RecordTypeEnum type, String whenExpression, Date date1, Date date2, SearchDateFieldOperatorEnum operator, Preferences preferences)
Answers a list of deleted records of a given record type that match a given date expression.
|
|
GetItemAvailabilityResult
|
getItemAvailability(RecordRef record, Date ifModifiedSince, Preferences preferences)
Answers the availability for a given record reference.
|
|
List<ReadResponse>
|
getList(List<? extends BaseRef> references, Preferences preferences)
This operation is used to retrieve a list of objects referenced in the list of BaseRef object.
|
|
MetaData
|
getMetaData(MetaDataKey key)
|
|
List<MetaDataKey>
|
getMetaDataKeys()
|
|
GetPostingTransactionSummaryResult
|
getPostingTransactionSummary(PostingTransactionSummaryField fields, PostingTransactionSummaryFilter filters, Integer pageIndex, Preferences preferences)
Use to retrieve a summary of the actual data in an account.
|
|
Map<String, Object>
|
getRecord(RecordRef recordRef, Preferences preferences)
This is used to retrieve a record by providing the unique id that identifies that record.
|
|
GetAllResult
|
getRecords(GetAllRecordType type, Preferences preferences)
This operation is used to retrieve a list of all records of the specified type.
|
|
GetSavedSearchResult
|
getSavedSearch(RecordType type)
Retrieves a list of existing saved searches for the given record type.
|
|
GetSelectValueResult
|
getSelectValue(int page, GetSelectValueFieldDescription fieldDescriptor, Preferences preferences)
Use to retrieve valid values for a given recordRef field where the referenced record type is not yet exposed in the Web services API or when the logged in role does not have permission to the instances of the record type.
|
|
Date
|
getServerTime()
Answers the server time, resulting in more accurate and reliable sync'ing of data than using
using local client time.
|
|
ReadResponse
|
initialize(InitializeRecord record, Preferences preferences)
Populates fields on transaction line items with values from a related record,
in a similar way empty text boxes are prepopulated within the Netsuite UI
Example:
|
|
List<ReadResponse>
|
initializeList(List<InitializeRecord> initializeRecord, Preferences preferences)
Use to emulate the UI workflow by pre-populating fields on transaction line items with values from a related record.
|
|
boolean
|
isConnected()
|
|
SessionResponse
|
mapSso(String userAccount, String userPartnerId, String authenticationToken, String userEmail, String userPassword, RecordRef userRole)
Use to automate the mapping between external applications credentials and NetSuite’s credentials for a user.
|
|
SearchResult
|
queryAsNativeResult(String query, boolean bodyFieldsOnly, Integer pageSize)
Return a list of records, or columns matching the query provided.
|
|
PagingDelegate<Map<String, Object>>
|
queryRecords(String query, boolean bodyFieldsOnly, PagingConfiguration pagingConfiguration)
Return a list of records.
|
|
SearchResult
|
search(SearchRecordTypeEnum searchRecord, Map<String, Object> criteria, boolean bodyFieldsOnly, boolean returnSearchColumns, Integer pageSize)
The search operation is used to execute a search on a specific record type based on a set of criteria.
|
|
SearchResult
|
searchMore(int pageIndex, boolean bodyFieldsOnly, boolean returnSearchColumns, Integer pageSize)
The seachMore operation is used to retrieve more records after an initial search operation.
|
|
SearchResult
|
searchMoreWithId(String searchId, int pageIndex, boolean bodyFieldsOnly, boolean returnSearchColumns, Integer pageSize)
The searchMoreWithId operation allows users to reference a specific search result set by its searchId, a parameter included in all search results.
|
|
SearchResult
|
searchNext(boolean bodyFieldsOnly, boolean returnSearchColumns, Integer pageSize)
The searchNext operation is used to retrieve the next set of records after an initial search operation.
|
|
SearchResult
|
searchWithExpression(SearchRecordTypeEnum searchRecord, String expression, boolean bodyFieldsOnly, boolean returnSearchColumns, Integer pageSize)
The search operation is used to execute a search on a specific record type based on a set of criteria.
|
|
void
|
setDefaultEndpoint(String defaultEndpoint)
|
|
SessionResponse
|
ssoLogin(String partnerAccount, String partnerId, String authenticationToken)
Use to establish a single sign-on connection.
|
|
void
|
updateCustomFieldsRecord(RecordType recordType, CustomFieldRefTypeEnum customFieldType, Map<String, Object> customFields, Preferences preferences)
Updates existing record's custom fields.
|
|
WriteResponse
|
updateInviteeStatus(RecordRef eventId, CalendarEventAttendeeResponseEnum status, Preferences preferences)
Sets a new invitation status for a given event.
|
|
List<WriteResponse>
|
updateInviteeStatusList(List<UpdateInviteeStatusReference> inviteeStatusList, Preferences preferences)
Sets a new invitation status for a given event.
|
|
List<WriteResponse>
|
updateList(String recordType, List<Map<String, Object>> records, Preferences preferences)
Used to update one or more existing records in the system by providing new values for the fields to
be updated for each record.
|
|
BaseRef
|
updateRecord(String recordType, Map<String, Object> attributes, Preferences preferences)
Updates an existing record.
|
|
List<WriteResponse>
|
updateRecordsList(List<? extends Record> records, Preferences preferences)
Used to update one or more existing records in the system by providing a list of records.
|
|
List<WriteResponse>
|
upsertList(String recordType, List<Map<String, Object>> records, Preferences preferences)
The upsertList operation is used to add or update one or more instances of a record type in NetSuite.
|
|
BaseRef
|
upsertRecord(String recordType, String externalId, Map<String, Object> attributes, Preferences preferences)
The upsert operation is used to add a new instance or to update an instance of a record in NetSuite.
|