Notes are used to attach information to another record. Use the notes record to create new notes and attach them to a specific record.

The note record is defined in the generalComm (communication) XSD.

Supported Operations

The following operations can be used to modify the note record.

add | addList | delete | deleteList | get | getDeleted | getList | getSavedSearch | getSelectValue | search | update | updateList | upsert | upsertList


You can also use the asynchronous equivalents of SOAP web services list operations. For information about asynchronous operations, see SOAP Web Services Asynchronous Operations. For more information about request processing, see Synchronous Versus Asynchronous Request Processing.

Field Definitions

The SOAP Schema Browser includes definitions for all body fields, sublist fields, search filters, and search joins available to this record. For details, see the SOAP Schema Browser’s note reference page.


For information on using the SOAP Schema Browser, see SOAP Schema Browser.

Usage Notes

A note must be associated with one and only one of these records. If values for more than one of these fields is submitted, an error is thrown.

Sample Code

The following SOAP and C# samples show how to add a note.

SOAP Request

      <preferences xmlns="">
      <add xmlns="">
         <record xsi:type="q1:Note" xmlns:q1="">
            <q1:title>-- note title goes here --</q1:title>
            <q1:noteType internalId="7" type="noteType" />
            <q1:note>-- memo goes here --</q1:note>
            <q1:activity internalId="39" type="calendarEvent" />
            <q1:author internalId="-5" type="employee" />


SOAP Response

      <ns1:documentInfo xmlns:ns1="">
      <addResponse xmlns="">
            <ns2:status isSuccess="true" xmlns:ns2="" />
            <baseRef internalId="27" type="note" xsi:type="ns3:RecordRef"
              xmlns:ns3="" />



          private void addNotes()
            Note note = new Note();
            RecordRef activityref = new RecordRef();
            activityref.internalId = "39";
            activityref.type = RecordType.calendarEvent;
            activityref.typeSpecified = true;
            note.activity = activityref;
            RecordRef authorref = new RecordRef();
            authorref.internalId = "-5";
            authorref.type = RecordType.employee;
            authorref.typeSpecified = true;
   = authorref;
            note.direction = NoteDirection._outgoing;
            note.directionSpecified = true;
            RecordRef notetyperef = new RecordRef();
            notetyperef.internalId = "7";
            notetyperef.type = RecordType.noteType;
            notetyperef.typeSpecified = true;
            note.noteType = notetyperef;
            DateTime searchDate = new DateTime();
            searchDate = DateTime.Now;
            searchDate = DateTime.Parse(searchDate.ToString("dd/MM/yyyy"));
            note.noteDate = searchDate;
            note.noteDateSpecified = true;
            note.title = "-- note title goes here --";
            note.note = "-- memo goes here --";
            WriteResponse writeRes = _service.add(note);
            if (writeRes.status.isSuccess)
                _out.writeLn("\nThe note " + note.internalId + " has been added successfully");


Related Topics

How to Use the SOAP Web Services Records Help
SOAP Web Services Supported Records
SOAP Schema Browser
SuiteTalk SOAP Web Services Platform Overview

General Notices