Notes
Create, update, delete, and query notes in SuiteCRM
Table Specific Information
Select
You can query the Notes table using any criteria in the WHERE clause. The driver will use the SuiteCRM API to filter the results.
SELECT * FROM Notes WHERE Subject LIKE '%test%' AND [Date Created] > '2017-10-09'
Insert
Create a Note by specifying any writable column.
INSERT INTO Notes (Subject,[Parent ID]) VALUES ('Test Note', 'AccountId')
Update
You can update any Note column that is writable, by specifying the Id.
UPDATE Notes SET Attachment = 'selected.docx' WHERE Id = 'Test123'
Delete
Remove a Note by specifying the Id.
DELETE FROM Notes WHERE Id = 10003
Columns
| Name | Type | ReadOnly | Description |
| ID [KEY] | String | False |
Unique identifier of the record. |
| AccountID | String | True |
The Id of the account associated with the note. |
| Assignedto | String | True |
The user name of the user assigned to the record. |
| AssignedUserId | String | False |
The Id of the user assigned to the record. |
| Attachment | String | False |
File name associated with the note (attachment). |
| CaseID | String | True |
The Id of the case associated with the note. |
| Contact | String | True |
The name of the contact associated with the note. |
| ContactID | String | False |
The Id of the contact the note is associated with. |
| CreatedById | String | True |
The Id of the user who created the record. |
| CreatedByName | String | True |
The user name of the user who created the record. |
| DateCreated | Datetime | True |
Date the record was created. |
| DateModified | Datetime | True |
The date the record was last modified. |
| Deleted | Bool | False |
The record deletion indicator. |
| DisplayinPortal? | Bool | False |
Portal flag indicator, which determines if the note is created via portal. |
| EmailAddress | String | True |
The email of the contact associated with the note. |
| EmbedinEmail? | Bool | False |
Embed flag indicator, which determines if the note is embedded in an email. |
| LeadID | String | True |
The Id of the lead associated with the note. |
| MimeType | String | False |
Attachment MIME type. |
| ModifiedById | String | True |
The user who last modified the record. |
| ModifiedByName | String | True |
The user name of the user who last modified the record. |
| Note | String | False |
Full text of the note. |
| OpportunityID | String | True |
The Id of the opportunity associated with the note. |
| ParentID | String | False |
The Id of the parent Sugar item. |
| ParentType | String | False |
Sugar module the Note is associated with. |
| Phone | String | True |
The phone number of the contact associated with the note. |
| RelatedTo | String | True |
The name of the parent object associated with the note. |
| Subject | String | False |
Title of the note. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Rows@Next | String |
Identifier for the next page of results. Do not set this value manually. |