Copyright NetSuite, Inc All rights reserved. Trademarks

Transcription

1

2 Copyright NetSuite, Inc All rights reserved., November 10, 2005 This document is the property of NetSuite, Inc., and may not be reproduced in whole or in part without prior written approval of NetSuite, Inc. Trademarks NetSuite, NetERP and NetCRM are provided by NetSuite, Inc, and NetSuite is a trademark of NetSuite, Inc. Oracle is a registered trademark of Oracle Corporation. Other product names mentioned in this document may be trademarks, servicemarks, or tradenames of their respective companies and are hereby acknowledged.

3 Chapter 1 Welcome In this Guide Supported Records Overview Business Records Search Records Record Internal IDs CustomFieldList Shared System Internal IDs General Guidelines Chapter 2 Customers Usage Notes Supported Operations Associated Records Returning a Contact List for a Customer Understanding Customer Stages Record Fields List Fields Search Record Fields Customer Status and Stage Internal IDs Chapter 3 Contacts Usage Notes Supported Operations Associated Records Record Fields List Fields Search Record Fields Chapter 4 Employee Usage Notes Supported Operations Associated Records Record Fields List Fields Search Record Fields

4 Chapter 5 Messages Usage Notes Supported Operations Associated Records Record Fields Attachments Encoding Storing Attachments Chapter 6 Notes Usage Notes Supported Operations Associated Records Record Fields Chapter 7 Phone Call Usage Notes Supported Operations Record Fields List Fields Search Record Fields Chapter 8 Events (CalendarEvent) Usage Notes Supported Operations Associated Records Recurrence Record Fields List Fields Search Record Fields Chapter 9 Tasks Usage Notes Supported Operations Associated Records Identifying Unique TaskContact List Records

5 Record Fields Search Record Fields Chapter 10 Cases Usage Notes Supported Operations Associated Records Record Fields List Fields Search Record Fields Case Status and Priority Internal IDs Chapter 11 Opportunities Usage Notes Supported Operations Associated Records Projected Total, Range High and Range Low Fields Item Lists Record Fields List Fields Search Record Fields Chapter 12 Sales Orders Usage Notes Supported Operations Record Fields List Fields Search Record Fields Chapter 13 Items Usage Notes Supported Operations Associated Records Shared Pricing Matrix List Billing Rates Item Options List Vendors List Search Record Fields

6 Inventory Items Record Fields List Fields Description Items Record Fields Discount Items Record Fields Markup Items Record Fields Payment Items Record Fields Subtotal Items Record Fields NonInventory Purchase Items Record Fields NonInventory Sales Items Record Fields NonInventory Resale Items Record Fields Other Charge Resale Items Record Fields Other Charge Purchase Items Record Fields Service Resale Items Record Fields Service Purchase Items Record Fields Service Sale Items Record Fields Other Charge Sale Items Record Fields Chapter 14 Other Lists Usage Notes Supported Operations Associated Records Permissions Record Fields Chapter 15 Custom Records Usage Notes Supported Operations

7 Working with References Record Fields Search Record Fields Country and State Enumerations Country Enumerations State Enumerations

8 Chapter 1 Welcome In this Guide Welcome to the NetSuite Web Services Platform. The NetSuite Web Services Platform provides programmatic access to your Netsuite data and business processes through an XMLbased application programming interface (API). This guide provides detailed information for each record supported by the NetSuite Web Services Platform. For an overview of the NetSuite Web Services Platform with detailed requirements and example code for each of the core Web services operations, refer to the Web Services Platform Guide. This manual contains a section for each supported record that describes the following: General description of the record and how it can be used. Usage notes for the record providing details for special cases. A list of all supported operations for that record. A list of all other records that the current record can be associated to. Tables listing all available fields with their requirements and a description of those fields. Sample code snippets to clarify some explanations. Supported Records The following records are currently supported in the NetSuite Web Services Platform. Record Type Entities Activities Transactions Support Records Customers Contacts Employee Events (CalendarEvent) Tasks Phone Call Opportunities Sales Orders Cases

9 Welcome Overview 2 Record Type Items Communications Miscellaneous Customization Records Inventory Items Description Items Discount Items Markup Items Payment Items Subtotal Items NonInventory Purchase Items NonInventory Sales Items NonInventory Resale Items Other Charge Resale Items Other Charge Purchase Items Service Resale Items Service Purchase Items Service Sale Items Other Charge Sale Items Messages Notes Other Lists Custom Records Overview Business Records A NetSuite business record is a top level record used in all operations other than the login and logout operations. These records represent specific business functions such as creating a Customer or updating an Opportunity. Business record fields are populated and sent via SOAP during a Web service request or response. Business records are also returned in get and search operations. Any field defined within a Web services business record must be of one of the following logical types. Note: When enumerations contain either special characters ( ( ) or reserved keywords ( private, public ), either.net and Axis may generate less usable code on the client side. To alleviate this problem, all enumerated values in NetSuite Web services are prepended with an underscore _, except for enumerated values from the platformcore, platformcoretyp, platformfaults, platformfaultstyp, and platformmsgs XSDs. For example, without the _,.NET prepends symbol to the variable, as

10 Welcome Overview 3 Type String Int Double Boolean Datetime RecordRef Enum WsEnum List Description Corresponds to the xsd:string type in the XML Schema Corresponds to the xsd:int type in the XML Schema Corresponds to the xsd:double in the XML Schema Corresponds to the xsd:boolean type in the XML Schema and has valid values of true or false. If not explicitly set to either true or false, then set as false. Corresponds to the xsd:datetime type in the XML Schema which conforms to the ISO 8601 standard. Corresponds to the RecordRef type in the XML Schema. References an nskey value for any other record in the system including system defined constants that are controlled by the system. Corresponds to a specific type defined as an enum in the XSD that represents system constants that are also available in the UI. Corresponds to a specific type defined as an enum in the XSD that represents system constants that are NOT available in the UI. A List references a type that is a list and should be explicitly defined in the in the XML Schema as a type. A list can either be null (if it s an optional field) or it must contain at least one entry unless otherwise noted. All list types have a List suffix. Since sublists are NOT keyed, you can NOT update a specific item in the list. Instead you must interact with the list as a whole as described in the Platform Guide. Search Records A NetSuite search record is defined as a top level record that is used in the request portion of a search operation. Any field defined within a Web services search record must be of one of the following logical types. Type String Int Double Boolean Datetime List MultiSelectRef MultiSelectEnum Description Corresponds to the SearchStringField type as defined in the Platform Guide. Corresponds to the SearchIntField type as defined in the Platform Guide. Corresponds to the SearchDoubleField type as defined in the Platform Guide. Corresponds to the SearchBooleanField type as defined in the Platform Guide. Corresponds to the SearchDateField type as defined in the Platform Guide. Corresponds to the SearchSelectField type as defined in the Platform Guide. Corresponds to the SearchSelectField type as defined in the Platform Guide. Corresponds to the SearchSelectField type as defined in the Platform Guide.

11 Welcome Overview 4 Record Internal IDs Each record type in NetSuite has a corresponding internal ID (or typeid). This internal ID is required when using ListOrRecordRef since the type of record being referenced needs to be specified. For example, in the following code a new ListOrRecordRef is created. The list references a specific Entity record as designated by the InternalId of 1011 and specifies that the record is of the type customer (-2). Note that customer records have a internalid of -2 as shown in the table below. ListOrRecordRef[] fieldnameentity = new ListOrRecordRef[1]; fieldnameentity[0] = new ListOrRecordRef(); fieldnameentity[0].setinternalid("1011"); fieldnameentity[0].settypeid("-2"); Following is a table which lists the record type and associated internal ID. Important: MultiSelect fields on custom records also reference these values since they contain ListOrRecordRefs. For details on working with custom records, see Chapter 15 "Custom Records". Record Type internalid (or typeid) Call -22 Case -23 Contact -6 Customer -2 Employee -4 Event -20 Item -10 Opportunity -31 Task -21 Transaction -30 CustomFieldList Most business records that are exposed through Web services have one or more custom fields attached to it. These custom fields are exposed through the CustomFieldList record type. Note: The Disable Mandatory Custom Field Validation preference as described in the Platform Guide determines whether a required custom field with no data provided throws an error or is accepted as a null value. Refer to the Platform Guide for more details on this preference setting.

12 Welcome Overview 5 Type Req. Default Notes customfield varies Yes Value of the custom field. Points to a type of CustomFieldRef in the XML Schema which is an abstract type. internalid string Yes the field instance internal ID id2 string No the record type id xsi:type xsi:type Yes This is a field that is automatically implemented by the XML Schema. The value should represent the concrete custom field type. Following is an example that contains an exerpt of the SOAP body for a list of custom fields. <customfieldlist> <customfield internalid= CUSTEVENT1 xsi:type= IntCustomFieldRef > <value>12</value> </customfield> <customfield internalid= CUSTEVENT2 xsi:type= MultiSelectCustomFieldRef > <value>john</value> <value>mike</value> <value>gary</value> </customfield> </customfieldlist> Shared System Internal IDs System internal IDs are shared between the following groups. Therefore, when referencing a record using RecordRef, providing the system internal ID without specifying a type is sufficient to uniquely identify the record within a given group. Entities: company, contact, customer, employee, group, internal, partner, vendor CRM: call, campaign, case, event, solution, task General Guidelines Following are some general guidelines to follow when working with NetSuite records. Field Lengths In this guide, field length limitations are provided for all string fields. The values provided indicate the character limitations for each field. If the limit is exceeded, an error is returned indicating which fields exceeded the limit and the maximum number of characters allowed for that field. Errors If a required field is missing for a given record within a request, an error is generated. The associated record is not processed and an appropriate error status code is returned. Note: Only records with the errors are not processed. If multiple records are submitted within the same request, any records without errors are processed.

13 Welcome Overview 6 Required Fields Required fields in the UI don t necessarily correspond to required fields in the Web Services interface. This is because there can be standard defaults that are applied if the field is not populated. For example, in the Event record type, the eventaccess field is required in the UI. It is optional in Web services because it has a default value of Public. Default Values The system provides default values only for fields that are not required. When applying a default value, the system first tries to use a specified value. If none is given, the system uses the default. If no default is given, the system enters null. User defined defaults through the UI do not apply to Web services. Custom Forms The Web services interface for a given record type is independent of any custom forms defined for that type in the UI. Images In order to reference an image, it first needs to be uploaded, and then referenced using the image name specified in the file cabinet. Hidden Fields (datecreated/createddate) There is a datecreated or createddate field for every supported record type. This field is writable. However, if the field is left empty for a request it is by default populated with the system generated date regardless of Web services defaults settings. Refer to Working with Hidden Fields on page 22 of the Platform Guide for more information on hidden fields. Note: In all cases the system creation time is preserved for audit trail purposes. Operations For simplicity, the NetSuite Web Services Platform is designed with all available fields listed for each record in each corresponding XSD. There is no differentiation as to what field is available for each individual operation. For example, add operations take a separate set of field values than the corresponding update operation for some records. If your web services request includes a field value for a field that is unavailable, an error is thrown for that submission. This document specifies whenever a field is not available for both an add and an update operation.

14 Welcome Overview 7 Note: If you are using Web services for data migration where there may be fields that need to be populated that are unavailable during an add operation, you should perform two consecutive requests. Submit an initial add or addlist request, with values for all fields available for an add operation, followed by an update or updatelist request, with values for the fields available only during an update operation. User Defined List In the NetSuite Web Services Platform, many fields require internal ID values that correspond to an item in a user defined list. To locate a specific internal ID for a value in a user defined list, ensure that the preference Web Services: Show internal IDs is enabled. Then, if you navigate to the appropriate list within NetSuite, the internal ID values (or nskeys) are displayed for each list item. For example, the entitystatus field in the Customer record takes an internal ID value from the user defined list at Setup > Sales Force Automation > customer Statuses. If you navigate to this page in NetSuite, and the Web Services: Show internal IDs is enabled, the internal ID (nskey) values for each item are displayed. Note: Some user defined lists can also be edited via Web services to modify the values for the list. For details, see Other Lists on page 130. Enumerated Lists If values being returned for WSEnum and Enum fields in a get or search operation do NOT match the values enumerated in the schema, the following warning is returned: Code = Invalid_data Message = Error in record number <id>: Invalid field value <field>. Please refer to the XSD for enumerated list of valid field values. In these cases, the existing data is corrupt and must be corrected before it can be retrieved using NetSuite Web services.

15 Chapter 2 Customers Customer records represent people or companies that purchase goods and services from your business. Use the Customer record to manage these customers. Client applications can create, update, or delete customer records. The Customer record is defined in the listrel (relationship) XSD. Customer Record in NetSuite UI: Usage Notes Supported Operations The following operations can be used to modify Customers records: add addlist update updatelist delete deletelist get

16 Customers Usage Notes 9 getlist search searchmore searchnext Associated Records The Customer Record is not directly associated to any other record. You can NOT retrieve or set relationships between Contacts, Notes, Opportunities, Cases or Messages and the Customer record using Web services. Important: To create a relationship between a contact and a customer, you can set the company field to the Customer's Internal Id when updating or adding a contact. See Chapter 3 "Contacts". Returning a Contact List for a Customer In order to return a list of contacts associated to a given customer record, you must first get the customer record and then perform a search for the contacts associated to that customer. Sample Java Code // First get your customer Customer c = (Customer)port.get(new RecordRef("17",RecordType.customer)).getRecord(); // Now do a specific search for the Contacts ContactSearch cts = new ContactSearch(); // Search for an exact match between Customer.EntityId and the ContactSearch Field Company. cts.setcompany(new SearchStringField(c.getEntityId(),SearchStringFieldOperator.is)); // Execute the search and you have your contactlist. SearchResult scts = port.search(cts); Understanding Customer Stages In the NetSuite UI, there are three possible stages that can be defined for a customer Lead, Prospect or Customer. When entering new customers into NetSuite, you can create the record as a Lead, Prospect or Customer record, or you can create the customer as a Lead and allow NetSuite to automatically update the stage as certain criteria are met. Lead: allows you to track all the information you need to convert a lead into a customer. Leads have no estimates, opportunities or transactions associated with them. If an estimate or opportunity is created for a lead, the lead becomes a prospect. If you create a sales transaction for a lead, the lead becomes a customer. Prospect: allows you to track all the information you need to convert a prospect into a customer. Prospects have no sales orders, invoices, cash sales or other sales transactions associated with them. They can have opportunities and estimates associated with them, however. If a sales transaction is created for a prospect, or an opportunity is closed for a prospect, the prospect becomes a customer. Customer: allows you to track all the information on your current customers.

17 Customers 10 This workflow is also maintained when working with Web services. The stage field indicates whether the customer is a Lead, Prospect or Customer as defined above. For example, if a customer record is defined as a Lead via Web services and then that customer record has an opportunity record associated with it via Web services, the Customer record stage field will automatically be updated to reflect the new Prospect stage. Once the opportunity record is updated to Closed-Won, the record stage field is automatically updated to Customer. To enter a new customer record at a specified stage, set the stage field to Lead, Prospect or Customer as desired. The following field definitions are available for working with customer records. Record Fields The fields defined below are used to add and update information in a customer record. Customer Length Req Mapping Notes internalid string Y/N This is a required field for update, delete and get operations. entityid String / 25 Y/N Customer The name of the customer record. Required on add and update. isinactive Boolean No Customer is Inactive This field is false by default. customform RecordRef Y/N None References an existing custom form for this record type. To ensure that field relationships defined within a desired custom form are maintained, you must provide the customform value. Also, if defaults are off, then customform is required, if defaults are on then the default form is used. Internal ID values for existing forms can be found at Setup > Customization > Entry Forms. parent RecordRef N Child Of References an existing customer record. companyname String / 40 N General / Company Name The name of the customer.

18 Customers 11 Length Req Mapping Notes category RecordRef N General / Category References a value in a user defined list at Lists > Accounting > Other Lists > customer Categories. For details on how to modify this list via Web services, see CustomerCategory on page 132. entitystatus RecordRef Y Status References a value in the status list defined at Setup > Sales Force Automation > customer Statuses. For a list of possible internal ID values, refer to Customer Status and Stage Internal IDs on page 18. The customer stage may be changed automatically when the entitystatus field is changed. For more information, see Understanding Customer Stages on page 9. language Enum N/A References a value in the Language system list. salesrep RecordRef N General / Sales Rep References an employee record. accountnumber String / 20 N Financial / Account Assigned account number for this customer. terms RecordRef N Financial / Terms References a value in a user-defined list at Lists > Accounting > Other Lists. creditlimit Double N Financial / Credit Limit A credit limit for this customer. If set, and depending on preferences, a warning is generated when this customer's limit is exceeded during a transaction addition. creditholdoverride Boolean N Financial / This is a read-only field. balance Double N Financial / Balance Customer's current accounts receivable balance. pricelevel RecordRef N Financial / Price Level References a value in a user-defined list at Lists > Accounting > Other Lists. This value sets the price level for selling to this customer. prefccprocessor RecordRef N Financial / Preferred Credit Card Processor References a record at Setup > Company > Credit Card Processors. Sets the credit card processor used to process orders.

19 Customers 12 Length Req Mapping Notes taxable Boolean N Financial / Taxable True indicates that this customer pays sales tax according to the rate defined in the taxitem field. False indicates that this customer does not pay sales tax. taxitem RecordRef N Financial / Tax Item References a value in a user-defined list at Lists > Accounting > Sales Tax Items. This value provides the standard tax rate associated with this customer. resalenumber String / 15 N Financial / Resale Number startdate Datetime N Financial / Start Date Customer's tax license number for cases where you do not collect sales tax from this customer because the merchandise will be resold. The date this person or company became a customer. enddate Datetime N Financial / End Date Projected end date for this customer (used in the case of a contract job) reminderdays Int N Financial / Reminder Days shippingitem RecordRef N Financial / Shipping Item Sets the number of days before the end date that a reminder should be sent for renewing a customer's contract or job. References a value in a user-defined list at Lists > Accounting > Shipping Items. This value sets the default shipping method for this customer. giveaccess Boolean N Access / Give Access send Boolean N Access / Send Notification Enables access to your NetSuite account for the customer. The level of access is defined by the role assigned in the accessrole field. The password field must also be set before the customer can login to NetSuite. If true, the customer is automatically notified via e- mail when new access to NetSuite is provided. accessrole RecordRef N Access / Role References a value in a user-defined list at Setup > Users/Roles > Manage Roles. This value sets the role assigned to this customer. password String / 16 N Access / Password Sets the password assigned to allow this customer access to NetSuite. The password must be at least 6 characters long and contain one number or special character. Special characters include:, ` # $ % ^ & * ) ; ' [ ] "{ }. password2 String / 16 N Access / Confirm Password Sets the password confirmation field.

20 Customers 13 Length Req Mapping Notes altphone String / 21 N General / Alt. Phone Phone numbers can be entered in the following formats: , , (999) , 1(999) or ext 9999 phone String / 21 N General / Phone Phone numbers can be entered in the following formats: , , (999) , 1(999) or ext 9999 fax String / 21 N General / Fax Sets the fax number for the customer. String / 25 N General / Sets the address for the customer. If giveaccess is also set to true this is the used by the customer for login. preference Enum N General / Type Reference to a value in a system list. Values: _PDF, _HTML. comments String / 999 N General / Comments URL String / 100 N General / Web Address Sets the URL associated with the customer. image RecordRef N General / Image References an image file that has already been uploaded to the account. unsubscribe Boolean N General / Unsubscribe Removes the customer from marketing campaign lists. For accounts with US and Canadian editions, this field defaults to False and can only be set on an Update operation. For accounts with UK and AUS editions, the field defaults to True and can only be set on an Add operation. territory RecordRef N General / Territory References a value in a user-defined list at Setup > Sales Force Automation > Manage Sales Territories. This value sets the sales territory this customer belongs in. leadsource RecordRef N General / Lead Sourc References a value in a user-defined list at Lists > Accounting > Other Lists. Sets how this customer was referred to the organization. For details on how to modify this list via Web services, see LeadSource on page 134. weblead string N NA This is a read-only hidden field that defines whether a customer registered via a NetSuite website. It returns a string of either Yes or No.

21 Customers 14 Length Req Mapping Notes partner RecordRef N General / Partner References a partner record. This value sets the partner responsible for referring this customer. referrer String / 100 keywords String / 4000 clickstream String / 262 lastpagevisited String / 50 visits firstvisit lastvisit Int Datetime Datetime datecreated Datetime on Add None: Hidden Field When adding a record, this field defaults to the current system date and time. This field can be overwritten but, if not, the default value is set regardless of any use default settings. currency RecordRef N Financial / Currency References a value in a user-defined list at Lists > Accounting > Currencies. This value sets the currency that all transactions involving this customer are conducted in. lastmodifieddate DateTime N None: Hidden Field This is a read only field. When updating a record, this field defaults to the current system date and time. openingbalance Double N Financial / Opening Balance openingbalancedate DateTime N Financial / Opening Balance Date stage Enum N No corresponding field in the UI. Corresonds to Lead, Prospect or Customer records. vatregnumber string Financial / Vat Registration Number Sets the opening balance of this customer's account. Sets the date of the balance entered in the Opening Balance field. This is a read only field that references a value in a system list. Possible values include LEAD, PROSPECT or CUSTOMER. This value refers to the stage of customer that is being created and are the values that should be submitted as the internal ID values when performing a search. NetSuite automatically updates the customer stage when certain customer status (entitystatus field) changes occur. For more information, see Understanding Customer Stages on page 9. For the UK edition only. Note that this field is not validated when submitted via Web services. creditcardslist List N See CreditCardsList on page 15.

22 Customers 15 addressbooklist List N See AddressbookList on page 15. customfieldlist List N See CustomFieldList on page 4. List Fields Length The fields defined below are used to add and update information in lists that are attached to the customer record. CreditCardsList Req Mapping Notes The creditcardslist field is a list field that allows you to provide multiple credit card entries for a customer. The customer can then use these entries for payments. These fields are all mapped to the Financial tab in the UI. Field Length ccnumber Int Y Credit Card Number ccexpiredate Datetime N Expiration Date ccname String / 30 N Cardholder Name paymentmethod RecordRef Y Credit Card Type Reference to a value in a user-defined list at Lists > Accounting > Other Lists. This value sets the type of card. For details on how to modify this list via Web services, see PaymentMethod on page 133. ccdefault Boolean N Default Credit Card Sets whether this credit card is automatically selected on Web store transactions for this customer. The value is false by default. AddressbookList The addressbooklist field is a list field that allows you to provide multiple addresses for a customer. These fields are all mapped to the Address tab in the UI. Field Length defaultshipping Boolean N Default Shipping This field is true by default. Sets whether this address is used as the customer's default shipping address on transactions and in the Web store. defaultbilling Boolean N Default Billing This field is true by default. Sets whether this address is used as this customer's default billing address on transactions and in the Web store. label String / 30 Y Label Sets the name of the address entry. attention String / 30 N Attention addressee String / 30 N Addressee

23 Customers 16 Field Length phone String / 30 N Phone addr1 String / 30 N Address 1 addr2 String / 30 N Address 2 city String / 30 N City state Enum N State/Province References a value in a system list. Refer to State Enumerations on page 146 for a list of possible values (_alabama, _alaska, _alberta...) as defined in the commontypes XSD. zip String / 13 N Zip Although not required, if this value is not provided it is not possible to use this address with 3rd party shippers. country Enum N Country References a value in a system list. Refer to Country Enumerations on page 139 for a list of possible values (_afghanistan, _albania, _algeria...) as defined in the commontypes XSD. addrtext String / 999 N Address override Boolean N Override This field is false by default. This flag affects the behavior of the addresstext element. If set to true, the submitted contents of the addresstext element are saved regardless of the individual address fields. If set to false, the submitted contents of the addrestext field are ignored, and the addresstext field is composed of the individual address fields. Search Record Fields The fields defined below are used to search information in customer records. CustomerSearch Type contname RecordRef Y Contact Reference to an existing contact record. primaryalternate RecordRef N Attach as Sets the contact as the primary or alternate contact for the customer. Internal ID values include PRIMARY or ALTERNATE (case sensitive). Only one contact can be set as the PRIMARY for a given customer. If multiple contacts are defined as PRIMARY the lastest modified contact is set as the PRIMARY and all others are reset as ALTERNATE. Search XSD Type Mapping CCDefault SearchBooleanField Sales: Default Credit Card CCExpDate SearchDateField Sales: CC Expire Date CCHolderName SearchStringField Sales: Cardholder Name CCNumber SearchStringField Sales: Credit Card Number

24 Customers 17 Search XSD Type Mapping CCType SearchMultiSelectField Sales: Credit Card Type URL SearchStringField Web Address giveaccess SearchBooleanField Login Access accountnumber SearchStringField Account active SearchBooleanField Inactive address SearchStringField Address availableoffline SearchBooleanField Always Available Offline balance SearchDoubleField Sales: Balance boughtamount SearchDoubleField Transactions: Total Amount Purchased boughtdate SearchDateField Transactions: Purchase Dates campaign SearchStringField Campaigns: Campaign campaignchannel SearchMultiSelectField Campaigns: Channel campaignpromocode SearchMultiSelectField Campaigns: Promotion Code campaignresponse SearchMultiSelectField Campaigns: Response campaignresponsecode SearchIntField campaignresponsedate SearchResponseDate Campaigns: Response Date category SearchMultiSelectField Category city SearchStringField City classbought SearchMultiSelectField Transactions: Class comments SearchStringField contact SearchStringField Contact country SearchMultiSelectField Country county SearchStringField datecreated SearchDateField Date Created creditlimit SearchDoubleField Sales: Credit Limit currency SearchMultiSelectField Currency custstage SearchMultiSelectField custstatus SearchMultiSelectField Sales: Status dateclosed SearchDateField Sales: Date Closed deptbought SearchMultiSelectField Transactions: Department SearchStringField enddate SearchDateField Sales: End Date entityid SearchStringField entitystatus SearchMultiSelectField fax SearchStringField Fax firstsaledate SearchDateField Transactions: Date of First Sale

25 Customers 18 Search XSD Type Mapping group SearchMultiSelectField Group image SearchStringField Image items Bought SearchMultiSelectField Transactions: Items Purchased itemsordered SearchMultiSelectField Transactions: Items Ordered lastmodified SearchDateField Last Modified language SearchStringField leadsource SearchMultiSelectField Sales: Lead Source locationbought SearchMultiSelectField Transactions: Location merchantaccount SearchMultiSelectField parent SearchMultiSelectField Sub of parentitemsbought SearchMultiSelectField partner SearchMultiSelectField Sales: Partner phone SearchStringField Phone pricelevel SearchMultiSelectField Price Level prospectdate SearchDateField Sales: Prospect Date reminderdate SearchDateField salesrep SearchMultiSelectField Sales Rep stage SearchEnumMultiSelectField Sales: Stage startdate SearchDateField Sales: Start Date state SearchMultiSelectField State/Province status SearchMultiSelectField Sales: Status targetcampaign SearchMultiSelectField Campaigns: Campaign: Event taxable SearchBooleanField Sales: Taxable territory SearchMultiSearchField Sales: Territory unsubscribed SearchBooleanField Subscription weblead SearchBooleanField zip SearchStringField Zip customfieldlist SearchCustomFieldList Customer Status and Stage Internal IDs The following table lists the internal IDs for all standard Customer Status and Stage values that can be used to populate the entitystatus or stage field. Note: In addition to the following standard custom status values, your organization may have defined custom Customer Status values. If the Show Internal IDs preference is enabled, you can confirm the internal ID values in the associated list. See Displaying Internal IDs (nskeys) in the Web Services Platform Guide.

26 Customers 19 Customer Statuses Customer Stages ID Status ID Stage 17 Dead LEAD Lead 6 New PROSPECT Prospect 18 Qualified CUSTOMER Customer 14 Closed Lost 9 Identified Decision Makers 8 In Discussion 11 In Negotiation 7 Opportunity Identified 10 Proposal 12 Purchasing 13 Closed Won 16 Lost Customer 15 Renewal

27 Chapter 3 Contacts Contacts represent people or companies that you deal with in the daily activity of your business. Use the Contact record to create, modify, or delete contacts and associate a contact to a parent record. The Contact record is defined in the listrel (relationship) XSD. Contact Record in the NetSuite UI: Usage Notes Supported Operations The following operations can be used to manipulate the Contact record. add addlist update updatelist delete deletelist

28 Contacts 21 get getlist search searchmore searchnext Associated Records A contact record can be associated with the following records in NetSuite. Contact Customer Opportunity Note: Contact records can only be associated with other records during an update operation. The parent record must first be added before a contact can be associated with it. The following field definitions are available for working with contact records. Record Fields The fields defined below are used to add and update information in a contact record. Contact Length internalid string N This is a required field for update, delete and get operations. entityid String / 25 Y Contact Sets how the contact's name appears in all lists isinactive Boolean N Contact is Inactive This element has a default value of false. If set to true, this contact is not displayed on the Contacts list in the UI and cannot be associated with other records.

29 Contacts 22 Length customform recordref Y/N None References an existing custom form for this record type. To ensure that field relationships defined within a desired custom form are maintained, you must provide the customform value. Also, if defaults are off, then customform is required, if defaults are on then the default form is used. Internal ID values for existing forms can be found at Setup > Customization > Entry Forms. salutation String / 5 N General / Mr./Ms... firstname String / 25 N General / First Name middlename String / 25 N General / Middle Name lastname String / 25 N General / Last Name This field is required for the Online Bill Pay feature. This field is required for the Online Bill Pay feature. company RecordRef N Company Sets the company this contact works for. This contact is then displayed in contact lists for this company. isprivate Boolean N Private This field has a default value of false. If set to true the contact can only be viewed by the user that entered the contact record (as recorded with the login operation). String / 25 N General / Sets the address for this contact. When this contact is invited to an event, a notification is sent to this address. alt String / 25 N General / Atl. phone String / 21 N General / Main Phone officephone String / 21 N General / Office Phone homephone String / 21 N General / Home Phone mobilephone String / 21 N General / Mobile Phone This field is required for the Online Bill Pay feature. Must be entered in the following formats: , , (999) , 1(999) or ext Must be entered in the following formats: , , (999) , 1(999) or ext Must be entered in the following formats: , , (999) , 1(999) or ext Must be entered in the following formats: , , (999) , 1(999) or ext 9999.

30 Contacts 23 Length fax String / 21 N General / Fax categorylist List N Category References a value in a user defined list at Lists > Accounting > Other Lists. This value sets the type of contact. For details on how to modify this list with Web services, see ContactCategory on page 131 title String / 64 N General / Job Title supervisor RecordRef N General / Supervisor References an existing contact. supervisorphone String / 21 N General / Sup. Phone Must be entered in the following formats: , , (999) , 1(999) or ext assistant RecordRef N General / Assistant This is a reference to an existing contact. assistantphone String / 21 N General / Assist. Phone comments String / 999 N General / Comments Must be entered in the following formats: , , (999) , 1(999) or ext image RecordRef N General / Image References an existing file in the file cabinet for your account. unsubscribe Boolean N General / Unsubscribe datecreated DateTime On None: Hidden Add List Fields This field has a default value of false. If set to true, the contact is unsubscribed from campaigns. When adding a record, this field defaults to the current system date and time. This field can be overwritten but if not the default value is set regardless of any use default settings. lastmodifieddate DateTime N None: Hidden This is a read only field. When updating a record, this field defaults to the current system date and time. addressbooklist List N See AddressbookList on page 24. companylist List N Available for update operations only. See on page 25. customfieldlist List N See CustomFieldList on page 4. The fields defined below are used to add and update information in lists that are attached to the contact record.

31 Contacts 24 CategoryList Type category RecordRef Y Contact Category AddressbookList References a value in a user-defined list at Lists > Accounting > Other Lists. Sets the category of the contact. For details on how to modify this list via Web services, see ContactCategory on page 131. The addressbooklist field is a list field that allows you to provide multiple addresses for a contact. These fields are all mapped to the Address tab in the UI. Length defaultshipping Boolean N Default Shipping This field is true by default. True sets this address as the default shipping address. defaultbilling Boolean N Default Billing This field is true by default. True sets this address as the default billing address. label String / 30 Y Label Reference name for this address. attention String / 30 N Attention addressee String / 30 N Addressee phone String / 30 N Phone addr1 String / 30 N Address 1 addr2 String / 30 N Address 2 city String / 30 N City state Enum N State/Province References a value in a system list. Refer to State Enumerations on page 146 for a list of possible values (_alabama, _alaska, _alberta...) as defined in the commontypes XSD. zip String / 13 N Zip country Enum N Country References a value in a system list. Refer to Country Enumerations on page 139 for a list of possible values (_afghanistan, _albania, _algeria...) as defined in the commontypes XSD. addrtext String / 999 N Address When override is set to True, accepts a string representing the complete address of the contact. When override is set to False, sets the complete address as a concatenation of the attention, addressee, addr1, addr2, city, state, zip and country fields. override Boolean N Override This field is false by default. This field affects the behavior of the addrtext element as described above.