SuiteCRM Connector Objects (suitecrmv4 Schema)

NameDescription
AccountsCreate, update, delete, and query accounts created in SuiteCRM
ACLRolesCreate, update, delete, and query the ACLRoles table in SuiteCRM
AlertsCreate, update, delete, and query the Alerts of your SuiteCRM account
BugsCreate, update, delete, and query the bugs in SuiteCRM
BusinessHoursCreate, update, delete, and query business hours information in SuiteCRM
CallsCreate, update, delete, and query calls in SuiteCRM
CallsRescheduleCreate, update, delete, and query rescheduled call information for the SuiteCRM calls
CampaignLogCreate, update, delete, and query logs related to SuiteCRM campaigns
CampaignsCreate, update, delete, and query the SuiteCRM project's campaigns
CaseEventsCreate, update, delete, and query the events related to the SuiteCRM cases
CasesCreate, update, delete, and query the SuiteCRM cases
CaseUpdatesCreate, update, delete, and query updated made to the SuiteCRM cases
ContactsCreate, update, delete, and query the contacts in SuiteCRM
ContractsCreate, update, delete, and query contracts in SuiteCRM
CurrenciesCreate, update, delete, and query currencies used in SuiteCRM financial trackings
DocumentRevisionsQuery and delete revisions to uploaded SuiteCRM documents
DocumentsCreate, update, delete, and query SuiteCRM documents
EAPMCreate, update, delete, and query the EAPM (External API Module) entries in SuiteCRM
EmailAddressCreate, update, delete, and query email addresses saved in SuiteCRM
EmailsCreate, update, delete, and query sent or received emails
EmailTemplatesCreate, update, delete, and query email templates to be used for emails
EmployeesCreate, update, delete, and query employees registered in the SuiteCRM project
EventsCreate, update, delete, and query events registered in the SuiteCRM project
InboundEmailCreate, update, delete, and query SuiteCRM inbound emails
IndexCreate, update, delete, and query the available indexes in SuiteCRM
IndexEventCreate, update, delete, and query the Index Event entries in SuiteCRM
InvoicesCreate, update, delete, and query the invoices saved in the SuiteCRM
LeadsCreate, update, delete, and query the registered Leads
LineItemGroupsCreate, update, delete, and query the SuiteCRM line items groups
LineItemsCreate, update, delete, and query line items in SuiteCRM
LocationsCreate, update, delete, and query locations in SuiteCRM
MapAddressCacheCreate, update, delete, and query information on the Map Address saved in the server cache
MapAreasCreate, update, delete, and query saved map areas in SuiteCRM
MapMarkersCreate, update, delete, and query Google Maps Map Markers saved in SuiteCRM
MapsCreate, update, delete, and query maps via Google Maps.
MeetingsCreate, update, delete, and query meeting information.
NotesCreate, update, delete, and query notes in SuiteCRM
OAuthConsumerKeysCreate, update, delete, and query information on OAuth keys distributed by the application.
OAuthTokensQuery currently active OAuth tokens
OpportunitiesCreate, update, delete, and query opportunities saved in SuiteCRM
OutboundEmailAccountsCreate, update, delete, and query the outbound email accounts table
PDFTemplatesCreate, update, delete, and query PDFTemplates table.
ProcessAuditCreate, update, delete, and query information on process audits
ProductCategoriesCreate, update, delete, and query the product categories.
ProductsCreate, update, delete, and query the products registered for the SuiteCRM project
ProjectsCreate, update, delete, and query projects registered in SuiteCRM
ProjectTemplatesCreate, update, delete, and query any saved project template.
QuotesCreate, update, delete, and query quotes saved in SuiteCRM
ReleasesCreate, update, delete, and query the registered releases.
ReportChartsCreate, update, delete, and query report charts.
ReportConditionsCreate, update, delete, and query report conditions.
ReportFieldsCreate, update, delete, and query the saved report fields.
ReportsCreate, update, delete, and query information on reports made in SuiteCRM.
RolesCreate, update, delete, and query the roles in SuiteCRM.
SavedSearchesQuery any saved searches
ScheduledReportsCreate, update, delete, and query information on SuiteCRM scheduled reports.
SchedulersCreate, update, delete, and query schedulers.
SecurityGroupsManagementCreate, update, delete, and query information on security groups
SpotsCreate, update, delete, and query the saved spots.
SuiteCRMFeedCreate, update, delete, and query information on the activity feed in the SuiteCRM project.
TargetListsCreate, update, delete, and query the saved target lists.
TargetsQuery targets saved in SuiteCRM
TasksCreate, update, delete, and query tasks in SuiteCRM.
TemplateSectionLineCreate, update, delete, and query the template section line entries in SuiteCRM
TrackersCreate, update, delete, and query the created trackers.
UsersCreate, update, delete, and query the SuiteCRM registered users.
WorkFlowCreate, update, delete, and query the wokflow actions in SuiteCRM
WorkFlowActionsCreate, update, delete, and query the wokflow actions in SuiteCRM.
WorkFlowConditionsCreate, update, delete, and query the workflow conditions in SuiteCRM.
NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringTrueNo
AddressStringTrueNoAddress from Google Maps of the account address.
AlternatePhoneStringFalseNoAn alternate phone number.
AnnualRevenueStringFalseNoAnnual revenue for this account.
AnyEmailStringTrueNoThe email address for the account.
AssignedtoStringTrueUsers.IdNoThe Id of the user assigned to the record.
AssignedUserStringFalseNoThe user name of the user assigned to the record.
BillingCityStringFalseNoThe city used for the billing address.
BillingCountryStringFalseNoThe country used for the billing address.
BillingPostalCodeStringFalseNoThe postal code used for the billing address.
BillingStateStringFalseNoThe state used for the billing address.
BillingStreetStringFalseNoThe second line of the billing address.
BillingStreet2StringTrueNoThe third line of the billing address.
BillingStreet3StringTrueNoThe fourth line of the billing address.
BillingStreet4StringTrueNoThe street address used for the billing address.
CampaignStringTrueNoThe campaign that generated the account.
CampaignIDStringFalseNoThe first campaign name for the account.
CreatedByIdStringTrueNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoThe full text of the alert.
EmailAddressStringFalseNoThe alternate email address for the account.
EmailOptOutBoolTrueNoWhether the account has opted out of emails.
EmployeesStringFalseNoNumber of employees. Can be a number (100) or range (50-100)
FaxStringFalseNoThe fax phone number of this account.
GeocodeStatusStringTrueNoGeocode from Google Maps of the account address.
IndustryStringFalseNoThe industry that the account belongs in.
InvalidEmailBoolTrueNoWhether the email address of the account has been marked as invalid.
LatitudeDoubleTrueNoLatitude from Google Maps of the account address.
LongitudeDoubleTrueNoLongitude from Google Maps of the account address.
MemberofStringFalseNoThe name of the parent of this account.
ModifiedByIdStringTrueNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
NameStringFalseNoThe name of the account.
NonPrimaryE-mailsStringTrueNoThe nonprimary email addresses of the account.
OfficePhoneStringFalseNoThe office phone number.
OwnershipStringTrueNoThe ownership of the account.
ParentAccountIDStringFalseNoThe Id of the parent of this account.
RatingStringFalseNoAn arbitrary rating for this account for use in comparisons with others.
ShippingCityStringFalseNoThe city used for the shipping address.
ShippingCountryStringFalseNoThe country used for the shipping address.
ShippingPostalCodeStringFalseNoThe ZIP code used for the shipping address.
ShippingStateStringFalseNoThe state used for the shipping address.
ShippingStreetStringFalseNoThe second line of the shipping address.
ShippingStreet2StringTrueNoThe third line of the shipping address.
ShippingStreet3StringTrueNoThe fourth line of the shipping address.
ShippingStreet4StringTrueNoThe street address used for for shipping purposes.
SICCodeStringFalseNoSIC code of the account.
TickerSymbolStringFalseNoThe stock trading (ticker) symbol for the account.
TypeStringFalseNoThe type of the account.
WebsiteStringFalseNoThe URL of the website for the account.
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the ACL role.
CreatedByIdStringTrueUsers.IdNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoThe role description.
ModifiedByIdStringTrueUsers.IdNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
NameStringFalseNoThe role name.
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the alert.
AssignedtoStringFalseUsers.IDNoThe Id of the user assigned to the record.
AssignedUserIdStringTrueNoThe user name of the user assigned to the record.
CreatedByIdStringTrueUsers.IDNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoText of the alert
IsReadBoolFalseNoWhether the alert has been read
ModifiedByIdStringTrueUsers.IDNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
NameStringFalseNoName assigned to the alert
TargetModuleStringFalseNoWhich SuiteCRM module the alert is for
TypeStringFalseNoType of alert
UrlRedirectStringFalseNoThe URL the alert redirects to
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the record.
AssignedUserIdStringFalseUsers.IdNoThe Id of the user assigned to the record.
AssignedUserNameStringTrueNoThe user name of the user assigned to the record.
CategoryStringFalseNoWhere the bug was discovered (e.g., Accounts, Contacts, or Leads).
CreatedByIdStringTrueUsers.IdNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe user who created the record.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoRecord deletion indicator.
DescriptionStringFalseNoThe full text of the note.
FixedInReleaseIdStringFalseReleases.IdNoThe software or service release that corrected the bug.
FixedInReleaseNameStringTrueNoThe name of the software or service release that corrected the bug.
FoundInReleaseIdStringFalseReleases.IdNoThe software or service release that manifested the bug.
ModifiedByIdStringTrueUsers.IdNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe user name of the user who last modified the record.
NumberIntFalseNoThe visual unique identifier. Cannot be updated.
PriorityStringFalseNoAn indication of the priority of the issue.
ReleaseNameStringTrueNoThe release name linked with the bug
ResolutionStringFalseNoAn indication of how the issue was resolved.
SourceStringFalseNoAn indicator of how the bug was entered (e.g., via Web or email).
StatusStringFalseNoThe status of the issue.
SubjectStringFalseNoThe short description of the bug.
TypeStringFalseNoThe type of issue (e.g., issue or feature).
WorkLogStringFalseNoFree-form text used to denote activities of interest.
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the business hour.
ClosingHoursStringFalseNoTime the business hours ends
CreatedByIdStringTrueUsers.IDNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DayStringFalseNoWhich day of the week is the business hour applied for
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoDescription for the business hour
ModifiedByIdStringTrueUsers.IDNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
NameStringFalseNoName given to the business hour
OpenBoolFalseNoWhether the business hour is open
OpeningHoursStringFalseNoTime the business hour starts
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the call.
AcceptLinkStringTrueNoThe accept status of the call.
AssignedtoStringFalseNoThe user name of the user assigned to the record.
AssignedUserStringTrueUsers.IdNoThe Id of the user assigned to the record.
CallAttemptHistoryStringTrueNoReschedule info of the call.
CallAttemptsStringTrueNoThe Number of times call was rescheduled.
ContactStringTrueNoThe contact name for the call.
ContactidStringTrueContacts.IdNoThe Id of the contact for the call.
CreatedByIdStringTrueUsers.IdNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe user name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoRecord deletion indicator.
DescriptionStringFalseNoThe full text of the note.
DirectionStringFalseNoIndicates whether call is inbound or outbound.
DurationHoursIntFalseNoThe hours portion of the call duration.
DurationMinutesIntFalseNoThe minutes portion of the call duration.
EmailReminderBoolTrueNoThe checkbox indicating whether or not the email reminder value is set.
EmailRemindersentBoolFalseNoWhether the email reminder is already sent.
EmailReminderTimeStringFalseNoWhen a email reminder alert should be issued. -1 means no alert; otherwise, the number of seconds prior to the start.
EndDateDatetimeFalseNoThe date when the call ends.
ModifiedByIdStringTrueUsers.IdNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe user name of the user who last modified the record.
NameStringFalseNoA brief description of the call.
OutlookIDStringFalseNoWhen the Suite Plug-in for Microsoft Outlook syncs an Outlook appointment, this is the Outlook appointment item Id.
ParentTypeStringFalseNoThe type of the parent Sugar object related to the call.
RecurringSourceStringFalseNoThe recurring source requesting the call
RelatedtoStringTrueNoThe name of the parent Sugar object related to the call.
RelatedtoIDStringFalseNoThe Id of the parent Sugar object identified by .
ReminderCheckedBoolTrueNoThe checkbox indicating whether or not the reminder value is set.
ReminderTimeStringFalseNoWhen a reminder alert should be issued. -1 means no alert; otherwise, the number of seconds prior to the start.
RemindersStringFalseNoList of reminders for the call
RepeatCountIntFalseNoNumber of recurrences.
RepeatDowStringFalseNoThe days of week in recurrence.
RepeatIntervalIntFalseNoThe interval of recurrence.
RepeatParentIDStringFalseNoThe Id of the first element of recurring records.
RepeatTypeStringFalseNoThe type of recurrence.
RepeatUntilDateFalseNoRepeat until the specified date.
StartDateDatetimeFalseNoThe date when the call starts.
StatusStringFalseNoThe status of the call (e.g., Held or Not Held).
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the call reschedule.
AssignedtoStringFalseNoThe Id of the user assigned to the record.
AssignedUserIdStringTrueNoThe user name of the user assigned to the record.
CallsStringFalseNoName of the rescheduled call
CallIdStringFalseCalls.IdNoId of the rescheduled call
CreatedByIdStringTrueNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoDescription for the call reschedule
ModifiedByIdStringTrueNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
NameStringFalseNoName given for the reschedule
ReasonStringFalseNoReason given for the reschedule
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the record.
ActivityDateDatetimeFalseNoThe date the activity occurred.
ActivityTypeStringFalseNoThe activity that occurred (e.g., Viewed Message, Bounced, or Opted out).
ArchivedBoolFalseNoIndicates if the item has been archived.
campaign_contentStringTrueNoThe campaign content.
campaign_idStringFalseCampaigns.IdNoThe identifier of the campaign associated with the campaign log.
campaign_nameStringTrueNoThe name of the campaign associated with the campaign log.
campaign_objectiveStringTrueNoThe campaign objective.
DateModifiedDatetimeFalseNoThe date the campaign log was last modified.
DeletedBoolFalseNoRecord deletion indicator.
HitsIntFalseNoNumber of times the item has been invoked (e.g., multiple click throughs).
LBL_MARKETING_IDStringFalseNoThe Id of the marketing email this entry is associated with.
marketing_nameStringFalseNoThe marketing name.
MoreInformationStringFalseNoMore information about the campaign log.
NameStringTrueNoThe name of the campaign associated with the campaign log.
ProspectListIDStringFalseTargetLists.IdNoThe prospect list from which the item originated.
recipient_emailStringTrueNoThe email of the recipient.
recipient_nameStringTrueNoThe name of the recipient.
RelatedIdStringFalseNoThe Id of the related record.
RelatedTypeStringFalseNoThe type of the related record.
TargetIDStringFalseNoThe identifier of the target record.
TargetTrackerKeyStringFalseNoThe identifier of the tracker URL.
TargetTypeStringFalseNoThe target record type (e.g., Contact or Lead).
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the campaign.
ActualCostDoubleFalseNoActual cost of the campaign.
AssignedUserIdStringFalseUsers.IdNoThe Id of the user assigned to the record.
AssignedUserNameStringTrueNoThe user name of the user assigned to the record.
BudgetDoubleFalseNoBudgeted amount for the campaign.
ContentStringFalseNoThe campaign description.
CreatedByIdStringTrueUsers.IdNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
CurrencyStringFalseCurrencies.IdNoCurrency in use for the campaign.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringTrueNoThe description for the campaign.
EndDateDateFalseNoEnding date of the campaign.
ExpectedCostDoubleFalseNoExpected cost of the campaign.
ExpectedRevenueDoubleFalseNoExpected revenue stemming from the campaign.
FrequencyStringFalseNoFrequency of the campaign.
ImpressionsIntFalseNoExpected click throughs manually entered by the campaign manager.
ModifiedByIdStringTrueUsers.IdNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
NameStringFalseNoThe name of the campaign.
ObjectiveStringFalseNoThe objective of the campaign.
StartDateDateFalseNoStarting date of the campaign.
StatusStringFalseNoStatus of the campaign.
TrackerIntFalseNoThe internal Id of the tracker used in a campaign. 2. (See CampaignTrackers.)
TrackerCountIntFalseNoThe number of accesses made to the tracker URL; no longer used as of 4.2. (See CampaignTrackers.)
TrackerLinkTextStringFalseNoThe text that appears in the tracker URL. No longer used as of 4.2. (See CampaignTrackers.)
TrackerRedirectURLStringFalseNoThe URL referenced in the tracker URL. No longer used as of 4.2. (See CampaignTrackers.)
TypeStringFalseNoThe type of the campaign.
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the case event.
AssignedtoStringTrueNoThe Id of the user assigned to the record.
AssignedUserIdStringTrueNoThe user name of the user assigned to the record.
CaseIdStringFalseCases.IdNoThe Id of the case the event is logged for
CaseStringFalseNoThe name of the case the event is logged for
CreatedByIdStringTrueUsers.IdNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
DateCreatedDatetimeFalseNo
DateModifiedDatetimeFalseNo
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoDescription of the case event
ModifiedByIdStringTrueUsers.IdNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
NameStringFalseNoName given for the case update
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier for the record.
AccountIDStringFalseAccounts.IdNoThe Id of the associated account.
AccountNameStringFalseNoThe name of the associated account.
account_name1StringTrueNoA second account for the case
AddressStringTrueNoAddress from Google Maps of the case.
AssignedUserIdStringFalseUsers.IdNoThe user Id assigned to the record.
AssignedUserNameStringTrueNoThe name of the user assigned to the record.
CaseAttachmentsStringTrueNoA display of case attachments
CaseUpdatesThreadedStringFalseNoA list of the case updates
CreatedbycontactStringTrueNoThe user name of the user who created the case contact.
CreatedByIdStringFalseUsers.IdNoThe Id of the user who created the record.
CreatedByNameStringFalseNoThe user name of the user who created the record.
DateCreatedDatetimeFalseNoThe date the record was created.
DateModifiedDatetimeFalseNoThe date the record was last modified.
DeletedBoolFalseNoRecord deletion indicator.
DescriptionStringFalseNoThe full text of the note.
GeocodeStatusStringTrueNoGeocode from Google Maps of the case.
InternalUpdateBoolFalseNoWhether the update is internal.
LatitudeDoubleTrueNoLatitude from Google Maps of the case.
LBL_CONTACT_CREATED_BY_IDStringTrueUsers.IdNoThe User that created the case's contact
LongitudeDoubleTrueNoLongitude from Google Maps of the case.
ModifiedByIdStringFalseUsers.IdNoThe Id of the user who last modified the record.
ModifiedByNameStringFalseNoThe user name who last modified the record.
NumberIntFalseNoThe user-visible unique identifier for the case.
PriorityStringFalseNoThe priority of the case.
ResolutionStringFalseNoThe resolution of the case.
StateStringFalseNoState the case is left in
StatusStringFalseNoThe status of the case.
SubjectStringFalseNoThe short description of the bug.
SuggestionsStringTrueNoCollection of suggestions left for the case.
TypeStringFalseNoThe type of case.
UpdateattachmentformStringTrueNoThe HTML text for the case's update attachment
UpdateTextStringTrueNoText associated with an update on the case.
WorkLogStringFalseNoFree-form text used to denote activities of interest.
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the case update.
AssignedtoStringFalseUsers.IdNoThe Id of the user assigned to the record.
AssignedUserIdStringTrueNoThe user name of the user assigned to the record.
CaseStringTrueNoThe name of the case related to the update
LBL_CASE_IDStringFalseCases.IdNoThe name of the case related to the update
ContactStringTrueNoName of the contact related to the update
LBL_CONTACT_IDStringFalseContacts.IdNoId of the contact related to the update
CreatedByIdStringTrueUsers.IdNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoDescription for the case update
Internal_UpdateBoolFalseNoWhether the update is internal.
ModifiedByIdStringTrueUsers.IdNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
NameStringFalseNoName assigned to the case update
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier for the record.
AcceptStatusStringTrueNoId of the event status
AcceptStatusCStringTrueNoThe call accept status fields.
AcceptStatusIdStringTrueNoThe Id of the accept status.
AcceptStatusMStringTrueNoThe meeting accept status fields.
AcceptStatusNameStringTrueNoThe name of the accept status.
AccountDisabledBoolFalseNoWhether the portal account has been disabled for the contact.
AccountIDStringTrueNoThe Id of the account associated with the contact.
AccountNameStringTrueNoThe name of the account associated with the contact.
AddressStringTrueNoAddress from Google Maps of the contact.
AlternateAddressCityStringFalseNoThe city for the alternate address.
AlternateAddressCountryStringFalseNoThe country for the alternate address.
AlternateAddressPostal_CodeStringFalseNoThe postal code for the alternate address.
AlternateAddressStateStringFalseNoThe state for the alternate address.
AlternateAddressStreetStringFalseNoThe street address for the alternate address.
AlternateAddressStreet2StringTrueNoThe second line of the alternate address.
AlternateAddressStreet3StringTrueNoThe third line of the alternate address.
AnyEmailStringTrueNoThe email for the contact.
AssignedtoStringTrueNoThe name of the user assigned to the record.
AssignedUserStringFalseUsers.IdNoThe user Id assigned to the record.
AssistantStringFalseNoThe name of the assistant of the contact.
AssistantPhoneStringFalseNoThe phone number of the assistant of the contact.
BirthdateDateFalseNoThe birthdate of the contact.
CampaignStringFalseNoThe first campaign name for Contact.
CampaignIDStringFalseNoThe campaign that generated the lead.
CreatedByIdStringFalseUsers.IdNoThe Id of the user who created the record.
CreatedByNameStringFalseNoThe name of the user who created the record.
DateCreatedDatetimeFalseNoThe date the record was created.
DateModifiedDatetimeFalseNoThe date the record was last modified.
DeletedBoolFalseNoRecord deletion indicator.
DepartmentStringFalseNoThe department of the contact.
DescriptionStringFalseNoThe full text of the note.
DoNotCallBoolFalseNoAn indicator of whether the contact can be called.
EmailStringTrueNoThe email and name of the contact.
EmailAddressStringFalseNoThe alternate email for the contact.
EmailOptOutBoolTrueNoWhether the contact has opted out of emails.
FaxStringFalseNoThe contact fax number.
FirstNameStringFalseNoThe first name of the contact.
FullnameStringTrueNoThe full name of hte contact.
GeocodeStatusStringTrueNoGeocode from Google Maps of the contact.
HomeStringFalseNoHome phone number of the contact.
InvalidEmailBoolTrueNoWhether the contact email has been marked as invalid.
JoomlaAccountIDStringFalseNoId of the contact's Joomla account.
LastNameStringFalseNoThe last name of the contact.
LatitudeDoubleTrueNoLatitude from Google Maps of the contact.
LBL_CONT_ACCEPT_STATUSStringTrueNoThe event accept status fields.
LBL_CONT_INVITE_STATUSStringTrueNoThe event invite status fields.
LBL_JOOMLA_ACCOUNT_ACCESSStringTrueNoAccess point for the contact's Joomla account.
LBL_LIST_ACCEPT_STATUS_EVENTStringTrueNoAccept status for the event
LBL_LIST_INVITE_STATUSStringTrueNoId for the event invite
LBL_LIST_INVITE_STATUS_EVENTStringTrueNoInvite status of the event
LeadSourceStringFalseNoThe lead source for the contact.
LongitudeDoubleTrueNoLongitude from Google Maps of the contact.
MobileStringFalseNoMobile phone number of the contact.
ModifiedByIdStringFalseUsers.IdNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe user name of the user who last modified the record.
NameStringTrueNoThe name of the contact.
NonPrimaryEmailsStringTrueNoThe nonprimary email addresses for the contact.
OfficePhoneStringFalseNoWork phone number of the contact.
OpportunityRoleStringTrueNoThe opportunity role.
OpportunityRoleFieldsStringTrueNoThe opportunity role fields.
OpportunityRoleIDStringTrueNoThe Id of the opportunity role.
OtherEmailStringTrueNoThe alternate email for the contact.
OtherPhoneStringFalseNoOther phone number for the contact.
PhotoStringFalseNoThe avatar for the contact.
PortalUserTypeStringFalseNoType of the contact's portal account.
PrimaryAddressCityStringFalseNoThe city for the primary address.
PrimaryAddressCountryStringFalseNoThe country for primary address.
PrimaryAddressPostalCodeStringFalseNoThe postal code for the primary address.
PrimaryAddressStateStringFalseNoThe state for the primary address.
PrimaryAddressStreetStringFalseNoThe street address for the alternate address.
PrimaryAddressStreet2StringTrueNoThe second line of the alternate address.
PrimaryAddressStreet3StringTrueNoThe third line of the alternate address.
ReportsToStringTrueNoThe name of the contact this contact reports to.
ReportstoIDStringFalseReports.IdNoThe Id of the contact this contact reports to.
SalutationStringFalseNoThe contact salutation (e.g., Mr. or Ms.).
SynctoOutlookregBoolTrueNoWhether the lead is synced to Outlook.
TitleStringFalseNoThe title of the contact.
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the contract.
AccountStringFalseNoAccount opened for the contract
AssignedUserIdStringTrueUsers.IdNoThe Id of the contract manager.
ContractManagerStringFalseNoName of the account manager
Call_IDStringFalseCall.IdNoId of the call linked to the contract
CompanySignedDateDateFalseNoDate the company signed the contract
ContactStringTrueNoName of the contact linked to the account
Contact_IdStringFalseContacts.IdNoId of the contact linked to the account
ContractTitleStringFalseNoTitle given to the contract
ContractTypeStringFalseNoType of the contract
ContractValueDoubleFalseNoValue of the contract
ContractValue(DefaultCurrency)DoubleFalseNoValue of the contract calculated in the system's default currency
Contract_Account_IdStringTrueAccounts.IdNoId of the Account linked to the contract
CreatedByIdStringTrueUsers.IdNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
CurrencyStringFalseNoId of the currency used in the contract
CustomerSignedDateDateFalseNoDate the customer signed the contract
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoDescription for the contract
DiscountDoubleFalseNoDiscount value for the account
Discount(DefaultCurrency)DoubleFalseNoDiscount value for the account in the system's default currency
EndDateDateFalseNoDate until the contract expires
GrandTotalDoubleFalseNoGrand total of the account
GrandTotal(DefaultCurrency)DoubleFalseNoGrand total of the account in the system's currency
LineItemsStringTrueNoLine items of the contract
ModifiedByIdStringTrueUsers.IdNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
OpportunityStringTrueNoName of the opportunity linked to the contract
Opportunity_IdStringFalseOpportunities.IdNoId of the opportunity linked to the contract
ReferenceCodeStringFalseNoReference code of the contract
RenewalReminderDateDatetimeFalseNoDate to remind for the contract renewal
ShippingDoubleFalseNoShipping costs of the contract
Shipping(DefaultCurrency)DoubleFalseNoShipping costs of the contract in the system's default currency
ShippingTaxStringFalseNoShipping tax costs
ShippingTax(DefaultCurrency)DoubleFalseNoShipping tax costs in the system's default currency
ShippingTaxAmountDoubleFalseNoAmount of the shipping tax
StartDateDateFalseNoDate the contract is valid from
StatusStringFalseNoStatus of the contract
SubtotalDoubleFalseNoSubtotal amount
Subtotal(DefaultCurrency)DoubleFalseNoSubtotal amount in the system's default currency
TaxDoubleFalseNoTax costs
Tax(DefaultCurrency)DoubleFalseNoTax costs in the system's default currency
TotalDoubleFalseNoTotal value of the contract
Total(DefaultCurrency)DoubleFalseNoTotal value of the contract in the system's default currency
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThe unique identifer of the currency.
ConversionRateDoubleFalseNoConversion rate factor (relative to stored value).
CreatedByIdStringFalseUsers.IdNoId of the user who created the record.
CreatedByNameStringFalseNoId of the user who created the record.
CurrencyNameStringFalseNoName of the currency.
CurrencySymbolStringFalseNoSymbol representing the currency.
DateCreatedDatetimeFalseNoDate the record was created.
DateModifiedDatetimeFalseNoDate the record was last modified.
DeletedBoolFalseNoRecord deletion indicator.
hideStringTrueNoHide status of the currency
ISO4217CodeStringFalseNo3-letter identifier specified by ISO 4217 (e.g., USD).
StatusStringFalseNoCurrency status.
unhideStringTrueNoUnhide status of the currency
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
RevisionNumber [KEY]StringFalseNoThe unique identifier for the document revision.
ChangeLogStringFalseNoThe change log for the document revision.
CreatedByIdStringTrueUsers.IdNoThe Id of the user who created the document.
CreatedByNameStringTrueNoThe name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the revision was entered.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoWhether the document revision is deleted.
DocumentNameStringTrueNoThe name of the document.
DocumentSourceIDStringFalseNoThe document Id from the Web service provider for the document.
DocumentSourceURLStringFalseNoThe document URL from the Web service provider for the document.
FileStringFalseNoThe file name of the document.
FileExtensionStringFalseNoThe file extension of the document.
LastRevisionIdStringTrueNoThe Id of the latest revision.
LatestRevisionStringTrueNoThe latest revision.
MimeTypeStringFalseNoThe MIME type of the document.
RelatedDocumentStringFalseNoThe Id for the associated document.
RevisionStringFalseNoThe revision number.
SourceStringFalseNoThe document type (e.g., Google, box.net, or IBM SmartCloud).
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier for the record.
AssignedtoStringTrueNoThe user name of the user assigned to the record.
AssignedUserIdStringFalseUsers.IdNoThe Id of the user assigned to the record.
CategoryStringFalseNoThe Id for the category of the document.
ContractnameStringTrueNoThe name of the document's contract
ContractstatusStringTrueNoThe document's contract status.
CreatedByIdStringTrueUsers.IdNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe user name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoRecord deletion indicator.
DescriptionStringFalseNoThe full text of the note.
DocumentNameStringFalseNoThe document name.
DocumentRevisionIdStringFalseNoThe Id of the document revision.
DocumentSourceIDStringFalseNoThe document Id from the Web service provider for the document.
DocumentSourceURLStringFalseNoThe document URL from the Web service provider for the document.
DocumentTypeStringFalseNoThe template type of the document.
ExpirationDateDateFalseNoThe date the document expires.
FileNameStringTrueNoThe file name of the document attachment.
IsaTemplateBoolFalseNoWhether the document is a template.
LastRevisionCreateDateDateTrueNoThe date the last revision was created.
LastrevisionMIMEtypeStringTrueNoThe MIME type of the last revision.
LastestrevisionnameStringTrueNoThe name of the latest revision.
LatestRevisionStringTrueNoThe latest revision.
LatestRevisionIdStringTrueNoThe Id of the latest revision.
LinkedidStringTrueNoThe Id of the linked record.
ModifiedByIdStringTrueUsers.IdNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe user name of the user who last modified the record.
NameStringTrueNoThe name of the document.
PublishDateDateFalseNoThe date the document is active.
RelatedDocumentStringTrueNoThe related document name.
RelatedDocumentIDStringFalseDocuments.IdNoThe Id of the related document.
RelatedDocumentRevisionStringTrueNoThe related document version number.
RelatedDocumentRevisionIDStringFalseNoThe Id of the related document revision.
RevisionStringTrueNoThe revision number.
RevisionCreatedByStringTrueNoThe name of the user who created the last revision.
SelectedrevisionfilenameStringTrueNoThe filename of the selected revision.
SelectedrevisionidStringTrueNoThe Id of the selected revision.
SelectedrevisionnameStringTrueNoThe name of the selected revision.
SourceStringFalseNoThe document type (e.g., Google, box.net, or IBM SmartCloud).
StatusStringTrueNoThe document status.
StatusIdStringFalseNoThe Id of the document status.
SubCategoryStringFalseNoThe Id of the subcategory of the document.
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoUnique identifier for the external API.
APIDataStringFalseNoAny API data that the external API may wish to store on a per-user basis.
AppPasswordStringFalseNoThe password of the external API.
AppUserNameStringFalseNoThe name of the external API.
ApplicationStringFalseNoThe application name of the external API.
AssignedUserIdStringFalseUsers.IdNoThe Id of the user assigned to the record.
ConnectedBoolFalseNoWhether the external API has been validated.
ConsumerKeyStringFalseNoThe consumer key for the external API.
ConsumerSecretStringFalseNoThe consumer secret for the external API.
CreatedByIdStringTrueUsers.IdNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoThe full text of the note.
ModifiedByIdStringTrueUsers.IdNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe user name of the user who last modified the record.
OAuthTokenStringFalseNoThe OAuth access token for the external API.
PleaseNoteStringTrueNoThe note for the external API.
SuiteCRMUserStringTrueNoThe name of the user assigned to the record.
URLStringFalseNoThe URL of the external API.
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the email address.
DateCreateDatetimeTrueNoThe date the email address was created.
DateModifiedDatetimeTrueNoThe date the email address was last modified.
DeleteBoolFalseNoWhether the email address is deleted.
EmailAddressStringFalseNoThe email address.
EmailAddresscapsStringFalseNoThe email address in uppercase.
InvalidEmailBoolFalseNoWhether the email address is marked as invalid.
OptedOutBoolFalseNoWhether the email address is marked as opt out.
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the email.
AssignedtoStringTrueNoThe user name of the user assigned to the record.
AssignedUserIdStringFalseUsers.IdNoThe Id of the user assigned to the record.
bcc_addrs_namesStringTrueNoThe bcc addresses in the email.
CC_Addrs_namesStringTrueNoThe cc addresses in the email.
CreatedByIdStringTrueUsers.IdNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe user name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DateSentDatetimeFalseNoThe date the email was sent.
DeletedBoolFalseNoThe record deletion indicator.
descriptionStringTrueNoThe description for the email.
description_htmlStringTrueNoThe HTML description for the email.
EmailStatusStringFalseNoThe status of the email.
FlaggedBoolFalseNoThe flagged status of the email.
from_addr_nameStringTrueNoThe from address in the email.
IntentStringFalseNoThe target of the action used in the Inbound Email assignment.
LBL_MAILBOX_IDStringFalseNoThe Id of the mailbox associated with the email.
MessageIDStringFalseNoThe Id of the email item obtained from the email transport system.
ModifiedByIdStringTrueUsers.IdNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe user name of the user who last modified the record.
NameStringFalseNoThe subject of the email.
Parent_IDStringFalseNoThe Id of the Sugar module associated with the email. (Deprecated as of 4.2.)
Parent_NameStringTrueNoThe name of the Sugar module associated with the email.
Parent_TypeStringFalseNoThe type of the Sugar module associated with the email. (Deprecated as of 4.2.)
raw_sourceStringTrueNoThe raw source for the email.
ReplyToStatusBoolFalseNoThe reply-to status of the email. If you reply to an email then the reply-to status of original email is set.
reply_to_addrStringTrueNoThe reply-to address in the email.
to_addrs_namesStringTrueNoThe to addresses in the email.
TypeStringFalseNoThe type of the email (e.g., draft).
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the email template.
AssignedUserIdStringFalseUsers.IdNoThe Id of the user assigned to the record.
AssignedUserNameStringFalseNoThe user name of the user assigned to the record.
BodyStringFalseNoPlaintext body of the resulting email.
CreatedByIdStringTrueUsers.IdNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoThe description for the email template.
ModifiedByIdStringTrueUsers.IdNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
NameStringFalseNoThe name of the email template.
PlainTextStringFalseNoThe HTML-formatted body of the resulting email.
PublishedBoolFalseNoThe published status of the record.
SubjectStringFalseNoThe subject of the resulting email.
TextOnlyBoolFalseNoWhether the email template is to be sent in text only.
TypeStringFalseNoThe type of the email template.
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the employee.
AcceptStatusCStringTrueNoThe status fields for the call accept status of the employee.
AcceptStatusIdStringTrueNoThe Id of the accept status of the employee.
AcceptStatusMStringTrueNoThe status fields for the meeting accept status of the employee.
AcceptStatusNameStringTrueNoThe name of the accept status of the employee.
AddressCityStringFalseNoThe city in the address of the employee.
AddressCountryStringFalseNoThe country in the address of the employee.
AddressPostalCodeStringFalseNoThe postal code in the address of the employee.
AddressStateStringFalseNoThe state in the address of the employee.
AddressStreetStringFalseNoThe street address of the employee.
AuthenticationIdStringFalseNoThe Id used in authentication.
CreatedByStringTrueUsers.IdNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe user name of the user who created the record.
DateEnteredDatetimeTrueNoThe date the employee record was entered into the system.
DateModifiedDatetimeTrueNoThe date the employee record was last modified.
DeletedBoolFalseNoWhether the employee is deleted.
DepartmentStringFalseNoThe department of the employee.
DescriptionStringFalseNoThe description for the employee.
DisplayEmployeeRecordBoolFalseNoWhether to show the employee.
EmailAddressStringTrueNoThe alternate email address of the employee.
EmailClientStringTrueNoThe link type of the email for the employee.
EmployeeStatusStringFalseNoThe status of the employee.
ExternalAuthenticationBoolFalseNoWhether the employee only has external authentication available.
FaxStringFalseNoThe fax of the employee.
FirstNameStringFalseNoThe first name of the employee.
FullnameStringTrueNoThe full name of the employee.
GroupUserBoolFalseNoWhether the employee is a group user.
HomePhoneStringFalseNoThe home phone number of the employee.
IMNameStringFalseNoThe Id of the instant messenger service used by the employee.
IMTypeStringFalseNoThe type of the instant messenger service used by the employee.
IsAdministratorBoolFalseNoWhether the employee is an admin.
IsUserBoolFalseNoWhether the employee has a Sugar login.
LastNameStringFalseNoThe last name of the employee.
LBL_PRIMARY_GROUPBoolTrueNoThe primary security group the employee is assigned to.
LBL_REPORTS_TO_IDStringFalseNoThe Id of who the employee reports to.
LBL_securitygroup_noninherit_idStringTrueNoThe security group's non-inheritance id.
LBL_SECURITYGROUP_NONINHERITABLEBoolTrueNoWhether the group is non inheritable.
MobileStringFalseNoThe mobile phone number of the employee.
ModifiedByIdStringTrueUsers.IdNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe user name of the user who last modified the record.
NameStringFalseNoThe name of the employee.
NotifyonAssignmentBoolFalseNoWhether the employee can receive notifications.
OtherStringFalseNoThe alternate phone of the employee.
PasswordStringFalseNoThe user hash of the employee.
Password_Last_ChangedDatetimeFalseNoThe date the password of the employee was last changed.
PhotoStringFalseNoThe Id of the picture.
PortalAPIUserBoolFalseNoWhether the employee is a portal-only user.
ReportstoStringTrueNoThe user name of who the employee reports to.
SecurityGroupStringTrueNoThe security group's fields that are selected for non-inheritance.
StatusStringFalseNoThe status of the employee.
SystemGeneratedPasswordBoolFalseNoWhether the employee has a system-generated password.
TitleStringFalseNoThe title of the employee.
UserNameStringFalseNoThe username of the employee.
UserTypeStringTrueNoThe user type of the employee.
WorkPhoneStringFalseNoThe work phone number of the employee.
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the event.
AcceptRedirectURLStringFalseNoThe URL to redirect to if the event is accepted
ActivityStatusStringFalseNoStatus type of the event activity
AssignedtoStringTrueNoThe user name of the user assigned to the record.
AssignedUserIdStringFalseUsers.IDNoThe Id of the user assigned to the record.
BudgetDoubleFalseNoBudget set for the event
CreatedByIdStringTrueUsers.IDNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
CurrencyStringFalseNoId of the currency used in the budget
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeclineRedirect_URLStringFalseNoThe URL to redirect to if the event is declined
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoDescription given for the event
DurationStringTrueNoComplete duration of the event
DurationHoursIntFalseNoNumber of hours the event lasts
DurationMinutesIntFalseNoNumber of minutes the event lasts
EmailInviteTemplateStringFalseNoTemplate for an email invite
EndDateDatetimeFalseNoDate the event ends
LBL_RESPONSE_LINKStringTrueNoUrl that accepts the event invitation
LBL_RESPONSE_LINK_DECLINEDStringTrueNoURL that declines the event invitation
LocationsStringTrueNoLocations the event will take place
ModifiedByIdStringTrueUsers.IDNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
NameStringFalseNoName given to the event
StartDateDatetimeFalseNoDate the event starts
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThe unique identifier of the inbound email.
Auto-ReplyTemplateStringFalse[Email Templates.Id](#email templates)NoThe inbound email's auto-reply template
CreatedByIdStringTrueUsers.IDNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeleteReadEmailsAfterImportBoolFalseNoWhether the emails are deleted after an import
DeletedBoolFalseNoThe record deletion indicator.
GroupFolderIdStringFalseNoId of the group's folder linked to the email
LBL_GROUP_IDStringFalseNoGroup Id linked to the email
LBL_SERVICEStringFalseNoService type of the inbound email
LBL_STORED_OPTIONSStringFalseNoStored options of the inbound email
MailServerAddressStringFalseNoURL of the mail server to retrieve inbound emails from
MailServerProtocolIntFalseNoMail protocol of the mail server
ModifiedByIdStringTrueUsers.IDNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
MonitoredFoldersStringFalseNoFolders monitored from the mail server
NameStringFalseNoname of the inbound email
PasswordStringFalseNoAuthentication password required to access the mail server
PersonalBoolFalseNoWhether the inbound email is personal
PossibleActionsStringFalseNoThe mail server's mailbox type
StatusStringFalseNoStatus of the inbound email
UserNameStringFalseNoSMTP Username to connect to the mail server
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the index.
AssignedtoStringTrueNoThe user name of the user assigned to the record.
AssignedUserIdStringFalseUsers.IdNoThe Id of the user assigned to the record.
CreatedByIdStringTrueUsers.IDNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoDescription for the index
LastOptimisedDatetimeTrueNoDate when the index was last optimized
LocationStringFalseNoModule where the index is applicable
ModifiedByIdStringTrueUsers.IDNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
NameStringFalseNoName given to te index
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the index event.
RecordIdStringFalseNoWhich record produced the event
RecordModuleStringFalseNoWhich module does the record exist in
ErrorStringFalseNoMessage of the event's recorded error
AssignedtoStringTrueNoThe user name of the user assigned to the record.
AssignedUserIdStringFalseUsers.IdNoThe Id of the user assigned to the record.
CreatedByIdStringTrueUsers.IDNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoDescription of the indexs event
ModifiedByIdStringTrueUsers.IDNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
NameStringFalseNoTitle of the index event
SuccessBoolFalseNoWhether the index event is successful
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the invoice.
AccountStringTrueNoBilling account for the invoice
AssignedtoStringTrueNoThe user name of the user assigned to the record.
AssignedUserIdStringFalseUsers.IdNoThe Id of the user assigned to the record.
BillingCityStringFalseNoCity where the billing account is recorded in
BillingCountryStringFalseNoCountry where the billing account is recorded in
BillingPostalCodeStringFalseNoPostal code of the billing account
BillingStateStringFalseNoState where the billing account is recorded in
BillingStreetStringFalseNoStreet where the billing account is recorded in
billing_account_idStringFalseAccounts.IdNoId of the billing account
billing_contact_idStringFalseContacts.IdNoId of the billing contact
ContactStringTrueNoName of the billing contact
CreatedByIdStringTrueUsers.IDNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
CurrencyStringFalseNoId of the currency used for currency values
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoDescription provided for the
DiscountDoubleFalseNoDiscount amount of the invoice
LBL_DISCOUNT__AMOUNT_USDOLLARDoubleFalseNoDiscount amount of the invoice in the system's default currency
DueDateDateFalseNoDue date of the invoice
GrandTotalDoubleTrueNoThe invoice's grand total
GrandTotal(DefaultCurrency)DoubleTrueNoThe invoice's grand total in the system's default currency
InvoiceDateDateFalseNoDate the invoice was issued
InvoiceNumberIntFalseNoNumber of the invoice
InvoiceTemplatesStringFalseNoTemplate applying to the invoice
LineItemsStringTrueNoThe invoice's list of line items
ModifiedByIdStringTrueUsers.IDNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
QuoteDateDateFalseNoDate of the invoice quote
QuoteNumberIntFalseNoNumber of the invoice quote
ShippingDoubleFalseNoShipping costs
Shipping(DefaultCurrency)DoubleFalseNoShipping costs in the system's default currency
ShippingCityStringFalseNoCity of the shipping destination
ShippingCountryStringFalseNoCountry of the shipping destination
ShippingPostalCodeStringFalseNoPostal Code of the shipping destination
ShippingStateStringFalseNoState of the shipping destination
ShippingStreetStringFalseNoAddress of the shipping destination
ShippingTaxStringFalseNoShipping tax costs
ShippingTax(DefaultCurrency)DoubleFalseNoShipping tax costs in the system's default currency
ShippingTaxAmountDoubleFalseNoAmount of te shipping tax
StatusStringFalseNoStatus of the invoice
SubtotalDoubleTrueNoSubtotal amount in the invoice
Subtotal(DefaultCurrency)DoubleTrueNoSubtotal amount in the invoice in the system's default currency
Subtotal+TaxDoubleTrueNoSubtotal and tax amount in the invoice
SubtotalTaxAmountDoubleTrueNoSubtotal and tax amount in the invoice in the system's default currency
TaxDoubleFalseNoTax costs in the invoice
Tax(DefaultCurrency)DoubleFalseNoTax costs in the invoice in the system's default currency
TitleStringFalseNoTitle assigned to the invoice
TotalDoubleTrueNoTotal amount in the invoice
Total(DefaultCurrency)DoubleTrueNoTotal amount in the invoice in the system's default currency
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the record.
AcceptStatusCStringTrueNoThe call accept status fields.
AcceptStatusIdStringTrueNoThe Id of the accept status.
AcceptStatusMStringTrueNoThe meeting accept status fields.
AcceptStatusNameStringTrueNoThe name of the accept status.
AccountDescriptionStringFalseNoDescription for the lead's account
AccountIDStringFalseAccounts.IdNoAccount the lead is linked to
AccountNameStringFalseNoThe name of the associated acocunt.
AddressStringTrueNoAddress from Google Maps of the lead.
AltAddressCityStringFalseNoThe city for the alternate address.
AltAddressCountryStringFalseNoThe country for the alternate address.
AltAddressPostalcodeStringFalseNoThe postal code for the alternate address.
AltAddressStateStringFalseNoThe state for the alternate address.
AltAddressStreetStringFalseNoThe street address for the alternate address.
AltAddressStreet2StringTrueNoThe second line of the alternate address.
AltAddressStreet3StringTrueNoThe third line of the alternate address.
AnyEmailStringTrueNoThe email for the lead.
AssignedtoStringTrueNoThe user name of the user assigned to the record.
AssignedUserStringFalseUsers.IdNoUser Id assigned to the record.
AssistantStringFalseNoThe name of the assistant of the lead.
AssistantPhoneStringFalseNoThe phone number of the assistant of the lead.
BirthdateDateFalseNoThe birthdate of the lead.
CampaignStringTrueNoThe lead's campaign name
CampaignIDStringFalseCampaigns.IdNoCampaign that generated the lead.
ContactIDStringFalseContacts.IdNoMain contact for the lead
ConvertedBoolFalseNoWhether the lead has been converted.
CreatedByIdStringTrueUsers.IdNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe user name of the user who created the record.
DateCreatedDatetimeTrueNoDate the record was created.
DateModifiedDatetimeTrueNoDate the record was last modified.
DeletedBoolFalseNoRecord deletion indicator.
DepartmentStringFalseNoThe department of the lead.
DescriptionStringFalseNoFull text of the note.
DoNotCallBoolFalseNoAn indicator of whether the lead can be called.
EmailAddressStringFalseNoThe alternate email for the lead.
EmailAddress2StringTrueNoEmail of WebToLead
EmailOptOutBoolTrueNoWhether the lead has opted out of radio.
EmailOptOut2BoolTrueNoWhether the prospect has opted out of WebToLead emails.
EventStatusIdStringTrueNoId of the lead's event status.
FaxStringFalseNoThe lead fax number.
FirstNameStringFalseNoThe first name of the lead.
FullnameStringTrueNoThe full name of the lead.
GeocodeStatusStringTrueNoGoogle Maps geocode status
HomePhoneStringFalseNoHome phone number of the lead.
InvalidEmailBoolTrueNoWhether the lead email has been marked as invalid.
LastNameStringFalseNoThe last name of the lead.
LatitudeDoubleTrueNoLatitude from Google Maps of the lead.
LBL_CONT_ACCEPT_STATUSStringTrueNoThe event accept status fields.
LBL_CONT_INVITE_STATUSStringTrueNoThe event invite status fields.
LBL_LIST_ACCEPT_STATUS_EVENTStringTrueNoStatus of the lead's event accept.
LBL_LIST_INVITE_STATUSStringTrueNoId of the lead's event invite.
LBL_LIST_INVITE_STATUS_EVENTStringTrueNoName of the lead's event status.
LeadInvalidEmailBoolTrueNoWhether the WebToLead email is invalid.
LeadSourceStringFalseNoHow the lead came to be known.
LeadSourceDescriptionStringFalseNoDescription of the lead source.
LongitudeDoubleTrueNoLongitude from Google Maps of the lead.
MobileStringFalseNoMobile phone number of the lead.
ModifiedByIdStringTrueUsers.IdNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe user name of the user who last modified the record.
NameStringTrueNoThe name of the lead.
NonPrimaryE-mailsStringTrueNoThe nonprimary email addresses for the lead.
OfficePhoneStringFalseNoWork phone number of the lead.
OpportunityAmountStringFalseNoThe amount the opportunity yields
OpportunityIDStringFalseOpportunities.IdNoThe Opportunity the lead was generated from
OpportunityNameStringFalseNoThe name of the opportunity the lead was generated from
OtherEmailStringTrueNoThe alternate email for the lead.
OtherEmail2StringTrueNoAlternate email of WebToLead
OtherPhoneStringFalseNoOther phone number for the lead.
PhotoStringFalseNoThe picture for the lead.
PortalApplicationStringFalseNoThe Joomla portal application of the lead
PortalNameStringFalseNoThe Joomla portal name of the lead
PrimaryAddressCityStringFalseNoThe city for the primary address.
PrimaryAddressCountryStringFalseNoThe country for the primary address.
PrimaryAddressPostalcodeStringFalseNoThe postal code for the primary address.
PrimaryAddressStateStringFalseNoThe state for the primary address.
PrimaryAddressStreetStringFalseNoThe street address used for the primary address.
PrimaryAddressStreet2StringTrueNoThe second line of the primary address.
PrimaryAddressStreet3StringTrueNoThe third line of the primary addrss.
ReferredByStringFalseNoThe Name of the lead's reference.
ReportsToStringTrueNoThe name the updates for the lead will be reported to
ReportsToIDStringFalseEmployees.IdNoThe name the updates for the lead will be reported to
SalutationStringFalseNoThe lead salutation (e.g., Mr. or Ms.).
StatusStringFalseNoStatus of the lead
StatusDescriptionStringFalseNoA description for the status
TitleStringFalseNoThe title of the lead.
WebsiteStringFalseNoThe lead's website
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the line items group.
AssignedtoStringTrueNoThe user name of the user assigned to the record.
AssignedUserIdStringFalseUsers.IdNoThe Id of the user assigned to the record.
CreatedByIdStringTrueUsers.IDNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
CurrencyStringFalseNoId of the currency used for currency values
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoDescription for the line items group
DiscountDoubleFalseNoGroup's discount value
Discount(DefaultCurrency)DoubleTrueNoGroup's discount value in the system's default currency
GroupNameStringFalseNoName assigned to the line items group
GroupTotalDoubleTrueNoGroup's total amount
GroupTotal(DefaultCurrency)DoubleTrueNoGroup's total amount in the system's default currency
ModifiedByIdStringTrueUsers.IDNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
NumberIntFalseNoNumber assigned to the group
LBL_PARENT_IDStringFalseNoParent record of this group
LBL_FLEX_RELATEStringTrueNoGroup's parent name
ParentTypeStringFalseNoParent't type of this group
SubtotalDoubleFalseNoGroup's subtotal amount
Subtotal(DefaultCurrency)DoubleFalseNoGroup's subtotal amount in the system's default currency
SubtotalTaxDoubleTrueNoGroup's subtotal and amount
SubtotalTaxAmountDoubleTrueNoGroup's subtotaland tax amount in the system's default currency
TaxDoubleFalseNoGroup's tax amount
Tax(DefaultCurrency)DoubleTrueNoGroup's tax amount in the system's default currency
TotalDoubleTrueNoGroup's total amount in the system's default currency
Total(DefaultCurrency)DoubleTrueNo
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the line item.
AssignedtoStringFalseNoThe user name of the user assigned to the record.
AssignedUserIdStringFalseUsers.IdNoThe Id of the user assigned to the record.
CostPriceDoubleFalseNoThe line item's cost price
CostPrice(DefaultCurrency)DoubleTrueNoThe line item's cost price in the system's default currency
CreatedByIdStringTrueUsers.IDNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
CurrencyStringFalseNoId of the currency used for currency values
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoDescription for the item
DiscountDoubleFalseNoThe line item's product discount
Discount(DefaultCurrency)DoubleTrueNoThe line item's product discount in the system's default currency
DiscountAmountDoubleFalseNoThe line item's discount amount
DiscountAmount(DefaultCurrency)DoubleTrueNoThe line item's discount amount in the system's default currency
DiscountTypeStringFalseNoThe type of discount for the item
GroupStringFalseNoGroup name the line item belongs to
group_idStringFalseLineItemGroups.IdNoGroup Id the line item belongs to
ListPriceDoubleFalseNoThe line item's list price
ListPrice(DefaultCurrency)DoubleTrueNoThe line item's list price in the system's default currency
ModifiedByIdStringTrueUsers.IDNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
NameStringFalseNoName assigned to the line item
NoteStringFalseNoDescription for the line item
NumberIntFalseNoNumber assigned to the line item
ParentIDStringFalseNoId of the line item's parent
RelatedtoStringFalseNoParent name the line item is related to
ParentTypeStringFalseNoId of the line item's parent
PartNumberStringFalseNoPart number assigned to the line items group
ProductIDStringFalseNoId assigned to the line item product
QuantityStringFalseNoQuantity of the line item
TaxStringFalseNoThe line item's VAT
TaxAmountDoubleFalseNoThe line item's VAT amount
TaxAmount(DefaultCurrency)DoubleTrueNoThe line item's VAT amount in the system's default currency
TotalPriceDoubleFalseNoThe line item's total price
TotalPrice(DefaultCurrency)DoubleTrueNoThe line item's total price in the system's default currency
UnitPriceDoubleFalseNoThe line item's unit price
UnitPrice(DefaultCurrency)DoubleTrueNoThe line item's unit price in the system's default currency
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the location.
AddressStringFalseNoStreet address of the location
AssignedtoStringTrueNoThe user name of the user assigned to the record.
AssignedUserIdStringFalseUsers.IdNoThe Id of the user assigned to the record.
CapacityStringFalseNoCapacity estimated for the location
CityStringFalseNoCity of the location
CountryStringFalseNoCountry of the location
CountyStringFalseNoCounty of the location
CreatedByIdStringTrueUsers.IDNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoDescription for the location
ModifiedByIdStringTrueNo
ModifiedByNameStringTrueNo
NameStringFalseNoName assigned to the location
PostcodeStringFalseNoPostal code of the location
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the address cache.
AddressStringFalseNoComplete address of the cached address
AssignedtoStringTrueNoThe user name of the user assigned to the record.
AssignedUserIdStringFalseUsers.IdNoThe Id of the user assigned to the record.
CreatedByIdStringTrueUsers.IDNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoDescription for the cached address
LatitudeDoubleFalseNoLatitude coordinate of the address
LongitudeDoubleFalseNoLongitude coordinate of the address
ModifiedByIdStringTrueUsers.IDNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the map area.
UserStringTrueNoThe user name of the user assigned to the record.
AssignedUserIdStringFalseUsers.IdNoThe Id of the user assigned to the record.
CityStringFalseNoCity of the map area
CoordinatesStringFalseNoGeographical coordinates of the map area
CountryStringFalseNoCountry of the map area
CreatedByIdStringTrueUsers.IDNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoDescription for the map area
ModifiedByIdStringTrueUsers.IDNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
NameStringFalseNoName assigned to the line items group
StateStringFalseNoState of the location
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the map marker.
UserStringTrueNoThe user name of the user assigned to the record.
AssignedUserIdStringFalseUsers.IdNoThe Id of the user assigned to the record.
CityStringFalseNoCity of the map marker
CountryStringFalseNoCountry of the map marker
CreatedByIdStringTrueUsers.IDNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoDescription for the map marker
LatitudeDoubleFalseNoLatitude coordinate of the map marker
LongitudeDoubleFalseNoLongitude coordinate of the map marker
MarkerImageTypeStringFalseNo
ModifiedByIdStringTrueUsers.IDNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
NameStringFalseNoName assigned to the map marker
StateStringFalseNoState of the map marker
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the map.
AssignedtoStringFalseNoThe user name of the user assigned to the record.
AssignedUserIdStringFalseUsers.IdNoThe Id of the user assigned to the record.
CreatedByIdStringTrueUsers.IDNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoDescription for the map
Distance(Radius)DoubleFalseNoRadius being covered in the map
ModifiedByIdStringTrueUsers.IDNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
ModuleTypetoDisplayStringFalseNoModule linked to the map
NameStringFalseNoName assigned to the map
ParentIDStringFalseNoId of the map's parent record
ParentTypeStringFalseNoType of the map's parent
Relatedto(Center)StringTrueNoName of the map's parent. Also identifies the map's center location
UnitTypeStringFalseNoLength unit expressing the radius
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier for the meeting.
AcceptLinkStringTrueNoThe accept status for the meeting.
AddressStringTrueNoAddress from Google Maps of the meeting.
AssignedtoStringFalseNoThe user name of the user assigned to the record.
AssignedUserIdStringFalseUsers.IdNoThe Id of the user assigned to the record.
ContactStringFalseNoThe name of the associated contact.
contact_idStringTrueNoThe Id of the associated contact.
CreatedByIdStringTrueUsers.IdNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe user name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoFull text of the note.
DirectionStringTrueNoWhether the meeting is inbound or outbound.
DisplayURLStringFalseNoThe meeting URL.
DurationStringTrueNoDuration handler dropdown.
DurationHoursIntFalseNoThe duration (hours).
DurationMinutesIntFalseNoThe duration (minutes).
EmailReminderBoolTrueNoWhether or not the email reminder value is set.
EmailRemindersentBoolFalseNoWhether the email reminder is already sent.
EmailReminderTimeStringFalseNoSpecifies when a email reminder alert should be issued: -1 means no alert; otherwise the number of seconds prior to the start.
EndDateDatetimeFalseNoDate the meeting ends.
ExternalAppIDStringFalseNoThe meeting Id for the external app API.
GeocodeStatusStringTrueNoGeocode from Google Maps of the meeting.
HostURLStringFalseNoThe host URL.
LatitudeDoubleTrueNoLatitude from Google Maps of the meeting.
LocationStringFalseNoThe location of the meeting.
LongitudeDoubleTrueNoLongitude from Google Maps of the meeting.
MeetingCreatorStringFalseNoThe meeting creator.
MeetingPasswordStringFalseNoThe password of the meeting.
MeetingupdatesequenceIntFalseNoMeeting update sequence for meetings as per iCalendar standards.
ModifiedByIdStringTrueUsers.IdNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe user name of the user who last modified the record.
OutlookIDStringFalseNoWhen the Sugar Plug-in for Microsoft Outlook syncs an Outlook appointment, this is the Outlook appointment item Id.
ParentIDStringFalseNoId of the first element of recurring records.
ParentTypeStringFalseNoModule the meeting is associated with.
RecurringSourceStringFalseNoSource of recurring meeting.
RelatedtoStringTrueNoThe name of the associated parent Sugar module.
ReminderCheckedBoolTrueNoWhether or not the reminder value is set.
ReminderTimeStringFalseNoSpecifies when a reminder alert should be issued: -1 means no alert; otherwise the number of seconds prior to the start.
RemindersStringTrueNoList of reminders set for the meetings
RepeatCountIntFalseNoNumber of recurrences.
RepeatDowStringFalseNoThe day of week of a meeting.
RepeatIntervalIntFalseNoThe interval of a recurring meeting.
RepeatParentIDStringFalseNoId of the first element of recurring records.
RepeatTypeStringFalseNoType of a recurring meeting.
RepeatUntilDateFalseNoRepeat until the specified date.
StartDateDatetimeFalseNoDate of the start of the meeting.
Start/JoinMeetingStringFalseNoThe join URL.
StatusStringFalseNoMeeting status (e.g., Planned, Held, or Not held).
SubjectStringFalseNoThe meeting name.
TypeStringFalseNoMeeting type (e.g., WebEx, or Other).
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoUnique identifier of the record.
AccountIDStringTrueNoThe Id of the account associated with the note.
AssignedtoStringTrueNoThe user name of the user assigned to the record.
AssignedUserIdStringFalseUsers.IdNoThe Id of the user assigned to the record.
AttachmentStringFalseNoFile name associated with the note (attachment).
CaseIDStringTrueNoThe Id of the case associated with the note.
ContactStringTrueNoThe name of the contact associated with the note.
ContactIDStringFalseNoThe Id of the contact the note is associated with.
CreatedByIdStringTrueUsers.IdNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe user name of the user who created the record.
DateCreatedDatetimeTrueNoDate the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DisplayinPortal?BoolFalseNoPortal flag indicator, which determines if the note is created via portal.
EmailAddressStringTrueNoThe email of the contact associated with the note.
EmbedinEmail?BoolFalseNoEmbed flag indicator, which determines if the note is embedded in an email.
LeadIDStringTrueNoThe Id of the lead associated with the note.
MimeTypeStringFalseNoAttachment MIME type.
ModifiedByIdStringTrueUsers.IdNoThe user who last modified the record.
ModifiedByNameStringTrueNoThe user name of the user who last modified the record.
NoteStringFalseNoFull text of the note.
OpportunityIDStringTrueNoThe Id of the opportunity associated with the note.
ParentIDStringFalseNoThe Id of the parent Sugar item.
ParentTypeStringFalseNoSugar module the Note is associated with.
PhoneStringTrueNoThe phone number of the contact associated with the note.
RelatedToStringTrueNoThe name of the parent object associated with the note.
SubjectStringFalseNoTitle of the note.
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the OAuth key.
UserStringTrueNoThe user name of the user the key has been assigned to.
AssignedUserIdStringFalseUsers.IdNoThe Id of the user the key has been assigned to.
ConsumerKeyNameStringFalseNoName assigned to the key
ConsumerKeyStringFalseNoKey value used in the OAuth 1.0 authentication with SuiteCRM
ConsumerSecretStringFalseNoSecret used in the OAuth 1.0 authentication with SuiteCRM
CreatedByIdStringTrueUsers.IDNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoDescription for the OAuth key
ModifiedByIdStringTrueUsers.IDNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the token.
CallbackURLStringFalseNoCallback URL given for the token
ConsumerStringFalseNoConsumer key associated with the token
ConsumerNameStringTrueNoThe consumer name given for the token
DeletedBoolFalseNoThe record deletion indicator.
LBL_ASSIGNED_TO_IDStringTrueNoThe user name of the user the token has been assigned to.
AssignedUserIdStringFalseNoThe Id of the user the token has been assigned to.
SecretStringFalseNoConsumer secret associeated with the token
Token_TSStringFalseNoTimestamp recorded for the token
TStateStringFalseNoCurrent state of the token
VerifyStringFalseNoVerification status of the token
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the opportunity.
AccountIDStringTrueNoThe Id of the associated account.
AccountNameStringTrueNoThe name of the associated account.
AddressStringTrueNoAddress from Google Maps of the opprtunity.
AmountDoubleFalseNoFormatted amount of the opportunity.
AssignedtoStringTrueNoThe user name of the user assigned to the record.
AssignedUserStringFalseUsers.IdNoThe Id of the user assigned to the record.
CampaignStringTrueNoThe name of the campaign that generated the lead.
campaign_idStringFalseNoThe Id of the campaign that generated the lead.
CreatedByIdStringTrueUsers.IdNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe user name of the user who created the record.
CurrencyStringFalseNoThe Id of the currency used for display purposes.
CurrencyNameStringTrueNoThe name of the currency used for display purposes.
CurrencySymbolStringTrueNoThe symbol of the currency used for display purposes.
DateCreatedDatetimeTrueNoDate the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoFull text of the note.
ExpectedCloseDateDateFalseNoThe expected or actual date the oppportunity will close.
GeocodeStatusStringTrueNoGeocode from Google Maps of the opprtunity.
LatitudeDoubleTrueNoLatitude from Google Maps of the opprtunity.
LeadSourceStringFalseNoSource of the opportunity.
LongitudeDoubleTrueNoLongitude from Google Maps of the opprtunity.
ModifiedByIdStringTrueUsers.IdNoUser who last modified the record.
ModifiedByNameStringTrueNoThe user name of the user who last modified the record.
NextStepStringFalseNoThe next step in the sales process.
OpportunityAmountDoubleFalseNoUnconverted amount of the opportunity.
OpportunityNameStringFalseNoName of the opportunity.
Probability(%)IntFalseNoThe probability of closure.
SalesStageStringFalseNoIndication of progression towards closure.
TypeStringFalseNoType of opportunity (e.g., Existing or New).
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the outbound account.
AssignedtoStringTrueNoThe user name of the user assigned to the record.
AssignedUserIdStringFalseUsers.IdNoThe Id of the user assigned to the record.
ChooseyourEmailproviderStringTrueNoidentifier for the email provider
CreatedByIdStringTrueUsers.IDNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
MailSendSmptTypeStringFalseNoSMTP Type of the connected account
LBL_MAIL_SENDTYPEStringFalseNoType of mail intended to be sent
LBL_MAIL_SMTPSSLStringFalseNoSecure layer protocol of the connected email account
ModifiedByIdStringTrueUsers.IDNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
NameStringFalseNoName assigned to the outbound account
PasswordStringTrueNoPassword set for the account
SendTestEmailStringTrueNo'Send Test Email' button content
SMTPPasswordStringFalseNoPassword to use in the SMTP authentication
SMTPPortIntFalseNoPort to use in the SMTP authentication
SMTPServerStringFalseNoServer address to use in the SMTP authentication
SMTPUsernameStringFalseNoUsername to use in the SMTP authentication
TypeStringFalseNoOutbound account type
UseSMTPAuthentication?BoolFalseNoWhether the account to be connected will use SMTP authentication
UserIdStringFalseUsers.IdNoId of the user linked with the account
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier for the pdf template.
ActiveBoolFalseNoWhether or not the template is active.
Assigned_toStringFalseNoThe assignee of the template.
Assigned_User_IdStringFalseUsers.IdNoThe unique identifier of the assignee.
BodyStringFalseNoContent of the template's body.
Created_ByStringFalseNoThe Id of the user who created the template.
Created_By2StringFalseNoThe name of the user who created the template.
Date_CreatedDatetimeFalseNoDate when the template was created.
Date_ModifiedDatetimeFalseNoDate when the template was modified.
DeletedBoolFalseNoWhether the template was deleted.
FooterStringFalseNoThe content of the template's footer.
HeaderStringFalseNoThe content of the template's header.
Insert_FieldsStringFalseNoThe fields that can be inserted.
Load_SampleStringFalseNoThe content of the template's sample.
Margin_BottomIntFalseNoValue of the bottom margin for the template.
Margin_FooterIntFalseNoValue of the margin for the template's footer.
Margin_HeaderIntFalseNoValue of the margin for the template's header.
Margin_LeftIntFalseNoValue of the left margin for the template.
Margin_RightIntFalseNoValue of the right margin for the template.
Margin_TopIntFalseNoValue of the top margin for the template.
Modified_ByStringFalseNoThe Id of the user who modified the template.
Modified_By2StringFalseNoThe name of the user who modified the template.
NameStringFalseNoThe template's name.
OrientationStringFalseNoOrientation of the template.
Page_SizeStringFalseNoThe size of the template.
TypeStringFalseNoThe type of the template.
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the inbound.
CreatedByIdStringTrueUsers.IDNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoDescription for the process audit
LBL_AOW_WORKFLOW_IDStringFalseWorflows.IdNoId of the workflow the audit is following
WorkflowStringTrueNoName of the workflow the audit is following
LBL_BEAN_IDStringFalseNoThe Id of the audit's parent record
RecordStringTrueNoName of the audit's parent record
ParentTypeStringFalseNoModule the audit's parent belongs to
ModifiedByIdStringTrueUsers.IDNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
NameStringFalseNoName assigned to the process audit
StatusStringFalseNoStatus of the audit
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the inbound.
AssignedtoStringTrueNoThe user name of the user assigned to the record.
AssignedUserIdStringFalseUsers.IdNoThe Id of the user assigned to the record.
CreatedByIdStringTrueUsers.IDNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoDescription for the category
IsparentcategoryBoolFalseNoWhether this category will be a parent for other categories
ModifiedByIdStringTrueUsers.IDNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
NameStringFalseNoName assigned to the category
ParentCategoryIDStringFalseNoId of the category's parent category
ParentCategoryStringTrueNoName of the parent category
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the ACL Action.
AssignedtoStringTrueNoThe user name of the user assigned to the record.
AssignedUserIdStringFalseUsers.IdNoThe Id of the user assigned to the record.
CategoryStringFalseNoName of the product's category.
ContactStringTrueNoProduct's point of contact name.
contact_idStringFalseNoProduct's point of contact id.
CostDoubleFalseNoCost of the product.
Cost(DefaultCurrency)DoubleFalseNoCost of the product in USD.
CreatedByIdStringTrueUsers.IdNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
CurrencyStringFalseNoThe Id of the currency used for the product.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoThe action description.
ModifiedByIdStringTrueUsers.IdNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
PartNumberStringFalseNoPart number of the product.
PriceDoubleFalseNoPrice of the product.
Price(DefaultCurrency)DoubleFalseNoPrice of the product in USD.
ProductCategoryStringTrueNoName of the product's category.
ProductCategoryIDStringFalseNoId of the product's category.
ProductCodeStringFalseNoThe code assigned to the product
ProductImageStringFalseNoImage uploaded for the product.
ProductNameStringFalseNoThe action name.
TypeStringFalseNoType of the product.
URLStringFalseNoUrl where the product can be seen.
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThe unique identifier of the project.
AddressStringTrueNoAddress from Google Maps of the project.
AssignedToStringFalseUsers.IdNoThe user name of the user assigned to the record.
ConsiderWorkingDaysBoolFalseNoWhether to include business hours in the project duration.
CreatedByIdStringTrueUsers.IdNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoProject description.
EndDateDateFalseNoThe estimated end date.
GeocodeStatusStringTrueNoGeocode from Google Maps of the project.
LatitudeDoubleTrueNoLatitude from Google Maps of the project.
LongitudeDoubleTrueNoLongitude from Google Maps of the project.
ModifiedByIdStringTrueUsers.IdNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
NameStringFalseNoProject name.
PriorityStringFalseNoThe priority of the project.
ProjectManagerStringTrueNoThe user name of the user assigned to the project.
ProjectTemplateStringTrueNoWhich project template was the project created from
StartDateDateFalseNoThe estimated start date.
StatusStringFalseNoThe status of the project.
TotalActualEffort(hrs)IntTrueNoThe total actual effort of the project.
TotalEstimatedEffort(hrs)IntTrueNoThe total estimated effort of the project.
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the project template.
TemplateNameStringFalseNoName assigned to the template
ProjectManagerStringTrueNoThe user name of the user the template has been assigned to
AssignedUserIdStringFalseUsers.IdNoThe Id of the user the template has been assigned to.
ConsiderWorkingDaysBoolFalseNoWhether to include working days in the project's effort
CreatedByIdStringTrueUsers.IDNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
ModifiedByIdStringTrueUsers.IDNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
NotesStringFalseNoDescription for the project template
PriorityStringFalseNoPriority to be assigned to the project
StatusStringFalseNoStatus to be assigned to the project
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNo
ApprovalIssuesStringFalseNo
ApprovalStatusStringFalseNo
AssignedtoStringTrueNo
AssignedUserIdStringFalseNo
BillingCityStringFalseNoCity where the billing account is recorded in
BillingCountryStringFalseNoCountry where the billing account is recorded in
BillingPostal_CodeStringFalseNoPostal code of the billing account
BillingStateStringFalseNoState where the billing account is recorded in
BillingStreetStringFalseNoStreet where the billing account is recorded in
billing_account_idStringFalseAccounts.IdNoId of the billing account
AccountStringTrueNoBilling account name for the quote
billing_contact_idStringFalseContacts.IdNoId of the billing contact
ContactStringTrueNoName of the billing contact
CreatedByIdStringTrueUsers.IDNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
CurrencyStringFalseNoId of the currency used for currency values
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoDescription for the quote
DiscountDoubleFalseNoThe quote's discount amount
Discount(DefaultCurrency)DoubleFalseNoThe quote's discount amount in the system's default currency
GrandTotalDoubleFalseNoThe quote's grand total
GrandTotal(DefaultCurrency)DoubleFalseNoThe quote's grand total in the system's default currency
InvoiceStatusStringFalseNoQuote's invoice status
LineItemsStringTrueNoThe list of the quote's line items
ModifiedByIdStringTrueUsers.IDNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
OpportunityStringTrueNoOpportunity name of the quote
opportunity_idStringFalseNoOpportunity Id of the quote
PaymentTermsStringFalseNoSelected terms for quote's payments
QuoteNumberIntFalseNoThe assigned quote number
QuoteStageStringFalseNoThe quote's assigned stage
QuoteTemplateStringFalseNoThe quote's template
ShippingDoubleFalseNoThe quote's shipping amount
Shipping(DefaultCurrency)DoubleFalseNoThe quote's shipping amount in the system's default currency
ShippingCityStringFalseNoCity of the shipping destination
ShippingCountryStringFalseNoCountry of the shipping destination
ShippingPostalCodeStringFalseNoPostal code of the shipping destination
ShippingStateStringFalseNoState of the shipping destination
ShippingStreetStringFalseNoStreet address of the shipping destination
ShippingTaxStringFalseNoThe quote's shipping tax costs
ShippingTax(DefaultCurrency)DoubleFalseNoThe quotes's discountamount in the system's default currency
ShippingTaxAmountDoubleFalseNoThe quotes's shipping tax amount
SubtotalDoubleFalseNoThe quotes's subtotal amount
Subtotal(DefaultCurrency)DoubleFalseNoThe quotes's subtotal amount in the system's default currency
SubtotalTaxDoubleFalseNoThe quotes's subtotal and tax amount
SubtotalTaxAmountDoubleFalseNoThe quotes's subtotal and tax amount in the system's default currency
TaxDoubleFalseNoThe quotes's tax amount
Tax(DefaultCurrency)DoubleFalseNoThe quotes's tax amount in the system's default currency
TermsStringFalseNoThe quote's terms
TitleStringFalseNoTitle assigned to the quote
TotalDoubleFalseNoThe quotes's total amount
Total(DefaultCurrency)DoubleFalseNoThe quotes's total amount in the system's default currency
ValidUntilDateFalseNoThe date the quote expires
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the record.
CreatedByStringTrueUsers.IdNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe Name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was entered.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoWhether the record is deleted.
ModifiedByIdStringTrueUsers.IdNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe Name of the user who last modified the record.
OrderIntFalseNoThe relative order in the drop-down list.
ReleaseVersionStringFalseNoThe name of the release.
StatusStringFalseNoThe status of the record.
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the inbound.
CreatedByIdStringTrueUsers.IDNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoDescription for the Report Chart
LBL_AOR_REPORT_IDStringFalseReports.IdNoThe report Id of the report the chart is built on
LBL_AOR_REPORT_NAMEStringTrueNoThe report name of the report the chart is built on
LBL_X_FIELDIntFalseNoLabel for the X coordinate in the report
LBL_Y_FIELDIntFalseNoLabel for the Y coordinate in the report
ModifiedByIdStringTrueUsers.IDNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
NameStringFalseNoName assigned to the chart
TypeStringFalseNoType of the report chart
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the inbound.
CreatedByIdStringTrueUsers.IDNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoDescription for the report condition
FieldStringFalseNoModule field to select for the condition
LBL_PARENTHESISStringFalseReportConditions.IdNoThe id of the report condition to enclose in the parenthesis
LogicStringFalseNoThe logic operator to link to the next condition
ModifiedByIdStringTrueUsers.IDNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
ModuleStringFalseNoWhich module to query in the condition
NameStringFalseNoName assigned to the condition
OperatorStringFalseNoThe operator to test against the value, such as 'Equal to', 'Less than'
OrderIntFalseNoDefines the order in which the condition will be resolved
ParameterBoolFalseNoWhether to treat the condition as a parameter
ReportIdStringFalseReports.IdNoThe report Id that the condition will apply to
TypeStringFalseNoWhat type of value to compare against
ValueStringFalseNoValue to use for comparison
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the report field entry.
CreatedByIdStringTrueUsers.IDNoThe Id of the user who created the record.
CreatedByNameStringTrueNo
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoDescription for the report field entry
DisplayBoolFalseNoWhether to display the selected field in the report
FieldStringFalseNoThe module field targeted for the report
FormatOptionsStringFalseNoAdditional format options
FunctionStringFalseNoFunction to be applied for the field
GroupBoolFalseNoWhether the results from this field are grouped
GroupOrderStringFalseNoThe order of the group by
LabelStringTrueNoThe field's label in its own module
LBL_AOR_REPORT_IDStringFalseNoThe report Id the report field will be applied to
LBL_GROUP_DISPLAYIntFalseNoWhether to display the group
LinkBoolFalseNoWhether to enable a link to the field
ModifiedByIdStringTrueUsers.IDNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
ModuleStringFalseNoThe module to retrieve the report field from
NameStringFalseNoName assigned to the report field entry
OrderIntFalseNoThe ordering of the report field
SortStringFalseNoSort this field by ASC or DESC
SortOrderStringFalseNoThe ordering of the sort for the report field
TotalStringTrueNoThe function that adds the results of the report query
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the report.
AssignedtoStringTrueNoThe user name of the user assigned to the record.
AssignedUserIdStringFalseUsers.IdNoThe Id of the user assigned to the record.
ChartsperrowIntFalseNoNumber of charts to display for each row
ConditionsStringTrueNoThe complete conditions of the report
CreatedByIdStringTrueUsers.IDNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoDescription for the report
DisplayFieldsStringTrueNoThe report fields selected for the report
ModifiedByIdStringTrueUsers.IDNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
NameStringFalseNoName assigned to the report
ReportModuleStringFalseNoThe module the report has targeted
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the role.
CreatedByIdStringTrueUsers.IdNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe Name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was entered.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoWhether the record is deleted.
DescriptionStringFalseNoThe description of the role.
ModifiedByIdStringTrueUsers.IdNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe Name of the user who last modified the record.
ModulesStringFalseNoThe modules the role has permission to access.
NameStringFalseNoThe name of the role.
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThe unique identifier of the saved search.
AssignedUserIdStringFalseUsers.IdNoUser Id assigned to the record.
AssignedUserNameStringTrueNoThe user name of the user assigned to the record.
ContentsStringFalseNoThe contents of the saved search.
LBL_CREATED_BYBoolFalseNoThe record deletion indicator.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DescriptionStringFalseNoThe description of the role.
ModuleStringFalseNoThe search's target module.
NameStringFalseNoThe name of the saved search.
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the scheduled report.
CreatedByIdStringTrueUsers.IDNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoDescription for the scheduled report
EmailRecipientsStringFalseNoList of email addresses the schedule results will be sent to
LastrunStringTrueNoDate of last run of the schedule
LBL_AOR_REPORT_IDStringFalseReports.IdNoReport Id of the report that is generated
ReportsStringTrueNoThe name of the report being scheduled to run
ModifiedByIdStringTrueUsers.IDNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
NameStringFalseNoName assigned to the schedule
ScheduleStringFalseNoThe schedule expressed in cron language
StatusStringFalseNoStatus of the schedule
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThe unique identifier of the scheduler.
ActiveFromStringFalseNoThe time the scheduler begins to be active per day.
ActiveToStringFalseNoTime the scheduler stops being active per day.
AdvancedOptionsBoolTrueNoWhether there are advanced options for the interval.
CreatedByIdStringTrueUsers.IdNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
DateTimeEndDatetimeFalseNoThe end date and time.
DateTimeStartDatetimeFalseNoThe start date and time.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
ExecuteIfMissedBoolFalseNoWhether the scheduler will catch up.
IntervalStringFalseNoThe job interval expressed in standard crontab notation
JobStringFalseNoThe job.
JobFunctionStringTrueNoThe job function.
JobNameStringFalseNoThe name of the scheduler.
JobURLStringTrueNoThe job URL.
LastSuccessfulRunDatetimeFalseNoThe last run time of the scheduler.
ModifiedByIdStringTrueUsers.IdNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
StatusStringFalseNoThe status of the scheduler.
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the security group.
AssignedtoStringTrueNoThe user name of the user assigned to the record.
AssignedUserIdStringFalseUsers.IdNoThe Id of the user assigned to the record.
CreatedByIdStringTrueUsers.IDNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoDescription for the security group
LBL_SECURITYGROUP_NONINHERITABLEBoolTrueNoWhether the group is inheritable
LBL_securitygroup_noninherit_idStringTrueNoNon-Inheritance Id
ModifiedByIdStringTrueUsers.IDNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
NameStringFalseNo
NotInheritableBoolFalseNoWhether the group is inheritable
PrimaryGroupBoolTrueNoWhether the group is primary
UserNameStringTrueNoUser fields for the group
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the record.
AssignedtoStringTrueNoThe user name of the user assigned to the record.
AssignedUser_IdStringFalseUsers.IdNoThe Id of the user assigned to the record.
ConfigStringFalseNoThe the configuration set of the spot.
ConfigurationStringTrueNoThe GUI settings of the spot.
CreatedByIdStringTrueUsers.IdNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoFull text of the note.
ModifiedByIdStringTrueUsers.IdNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
NameStringFalseNoThe name of the spot.
TypeStringFalseNoThe field this spot is targeting.
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the feed entry.
AssignedtoStringTrueNoThe user name of the user assigned to the record.
AssignedUserIdStringFalseUsers.IdNoThe Id of the user assigned to the record.
CreatedByIdStringTrueUsers.IDNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoDescription for the feed entry
LinkTypeStringFalseNoType of link to the feed
LinkUrlStringFalseNoThe URL to the feed
ModifiedByIdStringTrueUsers.IDNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
NameStringFalseNoA summary of the feed
RelatedIdStringFalseNoThe record Id related to the feed
RelatedModuleStringFalseNoThe module returned by the feed
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe Id of the target list.
AssignedtoStringTrueNoThe user name of the user assigned to the record.
AssignedUserIdStringFalseUsers.IdNoThe Id of the user assigned to the record.
CreatedByBoolFalseNoThe record deletion indicator.
CreatedByIdStringTrueUsers.IdNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DescriptionStringFalseNoThe description of the target list.
DomainNameStringFalseNoThe domain name of the target list.
MarketingIdStringTrueNoThe marketing Id of the target list.
MarketingNameStringTrueNoThe marketing name of the target list.
ModifiedByIdStringTrueUsers.IdNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
NameStringFalseNoThe name of the target list.
TargetsinListIntTrueNoThe entry count of the prospect list.
TypeStringFalseNoThe type of the target list.
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the record.
AccountNameStringFalseNoThe name of the associated acocunt.
AddressStringTrueNoAddress from Google Maps of the target.
AlternateAddressCityStringFalseNoThe city for the alternate address.
AlternateAddressCountryStringFalseNoThe country for the alternate address.
AlternateAddressPostalCodeStringFalseNoThe postal code for the alternate address.
AlternateAddressStateStringFalseNoThe state for the alternate address.
AlternateAddressStreetStringFalseNoThe street address for the alternate address.
AlternateAddressStreet2StringTrueNoThe second line of the alternate address.
AlternateAddressStreet3StringTrueNoThe third line of the alternate address.
AnyEmailStringTrueNoThe email for the target.
AssignedUserIdStringFalseUsers.IdNoThe Id of the user assigned to the record.
AssignedUserNameStringTrueNoThe user name of the user assigned to the record.
AssistantStringFalseNoThe name of the assistant of the target.
AssistantPhoneStringFalseNoThe phone number of the assistant of the target.
BirthdateDateFalseNoThe birthdate of the target.
CampaignIDStringFalseNoCampaign that generated the lead.
CreatedByIdStringTrueUsers.IdNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DepartmentStringFalseNoThe department of the target.
DescriptionStringFalseNoFull text of the note.
DoNotCallBoolFalseNoAn indicator of whether the target can be called.
EmailAddressStringFalseNoThe alternate email for the target.
EmailOptOutBoolTrueNoWhether the target has opted out of radio.
FaxStringFalseNoThe target fax number.
FirstNameStringFalseNoThe first name of the target.
FullNameStringTrueNoThe full name of the target.
GeocodeStatusStringTrueNoGeocode from Google Maps of the target.
HomeStringFalseNoHome phone number of the target.
InvalidEmailBoolTrueNoWhether the target email has been marked as invalid.
LastNameStringFalseNoThe last name of the target.
LatitudeDoubleTrueNoLatitude from Google Maps of the target.
LBL_CONT_ACCEPT_STATUSStringTrueNoThe event accept status fields.
LBL_CONT_INVITE_STATUSStringTrueNoThe event invite status fields.
LBL_LIST_ACCEPT_STATUSStringTrueNoId of the target's event status.
LBL_LIST_ACCEPT_STATUS_EVENTStringTrueNoStatus of the target's event accept.
LBL_LIST_INVITE_STATUSStringTrueNoId of the target's event invite.
LBL_LIST_INVITE_STATUS_EVENTStringTrueNoName of the target's event status.
LeadIdStringFalseNoThe Id of the associated lead.
LongitudeDoubleTrueNoLongitude from Google Maps of the target.
MobileStringFalseNoMobile phone number of the target.
ModifiedByIdStringTrueUsers.IdNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
NameStringTrueNoThe name of the target.
NonPrimaryE-mailsStringTrueNoThe nonprimary email addresses for the target.
OfficePhoneStringFalseNoWork phone number of the target.
OtherEmailStringTrueNoThe alternate email for the target.
OtherPhoneStringFalseNoOther phone number for the target.
PhotoStringFalseNoThe picture for the target.
PrimaryAddressCityStringFalseNoThe city for the primary address.
PrimaryAddressCountryStringFalseNoThe country for the primary address.
PrimaryAddressPostalCodeStringFalseNoThe postal code for the primary address.
PrimaryAddressStateStringFalseNoThe state for the primary address.
PrimaryAddressStreetStringFalseNoThe street address used for the primary address.
PrimaryAddressStreet2StringTrueNoThe second line of the primary address.
PrimaryAddressStreet3StringTrueNoThe third line of the primary addrss.
SalutationStringFalseNoThe target salutation (e.g., Mr. or Ms.).
TitleStringFalseNoThe title of the target.
TrackerKeyIntFalseNoThe key for the associated tracker.
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the record.
AssignedtoStringTrueNoThe name of the user assigned to the record.
AssignedUserIdStringFalseUsers.IdNoThe Id of the user assigned to the record.
ContactIDStringFalseContacts.IdNoThe Id of the associated contact.
ContactNameStringTrueNoThe name of the associated contact.
ContactPhoneStringTrueNoThe phone of the associated contact.
CreatedByIdStringTrueUsers.IdNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoThe full text of the note.
DueDateDatetimeFalseNoThe due date of the task.
DueTimeDatetimeTrueNoThe time the task is due.
EmailAddressStringTrueNoThe email of the associated contact.
ModifiedByIdStringTrueUsers.IdNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
NoDueDateBoolFalseNoWhether the task has a due date.
NoStartDateBoolFalseNoWhether the flag has a start date.
ParentIDStringFalseNoThe Id of the Sugar item to which the call is related.
ParentTypeStringFalseNoThe type of the Sugar item to which the call is related.
PriorityStringFalseNoThe priority of the task.
RelatedtoStringTrueNoThe name of the Sugar item to which the call is related.
StartDateDatetimeFalseNoThe start date of the task.
StatusStringFalseNoThe status of the task.
SubjectStringFalseNoThe name of the task.
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the template section line.
CreatedByIdStringTrueNoThe user name of the user assigned to the record.
CreatedByNameStringTrueNo
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoComplete HTML text for the line
GroupStringFalseNoThe group assigned to the line
ModifiedByIdStringTrueUsers.IDNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
NameStringFalseNoName assigned to the template section line
OrderIntFalseNoThe line order of the section compared to the other lines in the group
ThumbnailStringFalseNoImage url
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]IntFalseNoThe unique identifier of the tracker.
ActionStringFalseNoThe type of action being tracked
DateofLastActionDatetimeTrueNoDate when the action last took place
DeletedBoolFalseNoThe record deletion indicator.
ItemIdStringTrueNoId of the record being tracked
ItemSummaryStringTrueNoName of the record being tracked
MonitorIdStringTrueNoId of the tracker monitor
RecordVisibleBoolTrueNoWhether the record is visible
SessionIdStringTrueNoWhich session Id made the change
TrackersStringFalseNoThe module being tracked
UserIdStringTrueUsers.IdNoUser Id that made the change
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the user.
AcceptStatusCStringFalseNoThe fields for the accept status of the call.
AcceptStatusIdStringFalseNoThe Id of the accept status.
AcceptStatusMStringFalseNoThe fields for the accept status of the meeting.
AcceptStatusNameStringFalseNoThe name of the accept status.
AddressCityStringFalseNoThe city in the address.
AddressCountryStringFalseNoThe country in the address.
AddressPostalCodeStringFalseNoThe ZIP code in the address.
AddressStateStringFalseNoThe state in the address.
AddressStreetStringFalseNoThe street address of the user.
AssignedToStringFalseUsers.IdNoThe Id of the user who created the record.
AuthenticationIdStringFalseNoThe authentication Id.
CreatedByNameStringTrueNoThe name of the user who created the record.
DateEnteredDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DepartmentStringFalseNoThe department of the user.
DescriptionStringFalseNoThe description for the user.
DisplayEmployeeRecordBoolFalseNoWhether the user is shown on the employees tab.
EmailAddressStringFalseNoThe alternate email address of the user.
EmailClientStringFalseNoThe link type of the email.
EmployeeStatusStringFalseNoThe status of the employee.
ExternalAuthenticationBoolFalseNoWhether only external authentication is enabled for the user.
FaxStringFalseNoThe fax of the user.
FirstNameStringFalseNoThe first name of the user.
FullNameStringFalseNoThe full name of the user.
GroupUserBoolFalseNoWhether the user is a group.
HomePhoneStringFalseNoThe home phone number of the user.
IMNameStringFalseNoThe Id of the messenger.
IMTypeStringFalseNoThe type of the messenger.
IsAdministratorBoolFalseNoWhether the user is an admin.
IsSuiteCRMUserBoolFalseNoWhether the user is SuiteCRM user. If not, it is a guest user.
LastNameStringFalseNoThe last name of the user.
LBL_SECURITYGROUP_NONINHERITABLEBoolFalseNoWhether the group is non inheritable.
LBL_securitygroup_noninherit_idStringFalseNoThe security group's non-inheritance id.
MobileStringFalseNoThe mobile phone number of the user.
ModifiedByIdStringTrueUsers.IdNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
NameStringFalseNoFull name for the user
NotifyonAssignmentBoolFalseNoWhether the user can receive notifications.
OtherPhoneStringFalseNoThe alternate phone number of the user.
PasswordStringFalseNoThe hashed password for the user.
PasswordLastChangedDatetimeFalseNoThe date and time the password was last changed.
PhotoStringFalseNoThe photo for the user.
PortalAPIUserBoolFalseNoWhether the user is portal only.
PrimaryGroupBoolFalseNoThe primary security group the user is assigned to.
ReportstoStringFalseNoThe name of the manager of the user.
ReportstoIDStringFalseNoThe Id of the manager of the user.
SecurityGroupStringFalseNoThe security group's fields that are selected for non-inheritance.
StatusStringFalseNoThe status of the user.
SystemGeneratedPasswordBoolFalseNoWhether the user has a system-generated password.
TitleStringFalseNoThe title of the user.
UserTypeStringFalseNoThe type of the user.
UsernameStringFalseNoThe user name of the user.
WorkPhoneStringFalseNoThe work phone number of the user.
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the inbound.
ActionsStringTrueNoThe list of actions to be taken in the workflow
AssignedtoStringTrueNoThe user name of the user assigned to the record.
AssignedUserIdStringFalseUsers.IdNoThe Id of the user assigned to the record.
CreatedByIdStringTrueUsers.IdNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
ConditionsStringTrueNoThe list of conditions to be applied during the workflow
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoDescription for the worflow
LBL_RUN_ONStringFalseNoWhich records the workflow will operate on
ModifiedByIdStringTrueUsers.IdNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
NameStringFalseNoName assigned to the workflow
RepeatedRunsBoolFalseNoWhether the worflow will run once or several times
RunStringFalseNoOn which occasion the workflow will execute
StatusStringFalseNoThe status of the workflow
WorkflowModuleStringFalseNoThe module the workflow will target
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the workflow.
ActionStringFalseNoThe Specific action to be taken during the worklow
CreatedByIdStringTrueUsers.IdNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoDescription for the workflow
LBL_ORDERIntFalseNoThe order of the worflow's action
LBL_WORKFLOW_IDStringFalseWorkflow.IdNoThe wokflow the action is linked to
ModifiedByIdStringTrueUsers.IdNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
NameStringFalseNoName assigned to the action
ParametersStringFalseNoList of parameters for the action
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ID [KEY]StringFalseNoThe unique identifier of the inbound.
CreatedByIdStringTrueUsers.IdNoThe Id of the user who created the record.
CreatedByNameStringTrueNoThe name of the user who created the record.
DateCreatedDatetimeTrueNoThe date the record was created.
DateModifiedDatetimeTrueNoThe date the record was last modified.
DeletedBoolFalseNoThe record deletion indicator.
DescriptionStringFalseNoDescription for the workflow condition
FieldStringFalseNoThe module field selected for the condition
ModifiedByIdStringTrueUsers.IdNoThe Id of the user who last modified the record.
ModifiedByNameStringTrueNoThe name of the user who last modified the record.
ModuleStringFalseNoThe module selected to apply the condition
NameStringFalseNoName assigned to the workflow condition
OperatorStringFalseNoOperator to test against
LBL_ORDERIntFalseNoThe condition's order in the workflow
LBL_WORKFLOW_IDStringFalseWorkflow.IdNoThe workflow the condition will be applied for
TypeStringFalseNoType of the field
ValueStringFalseNoThe value to compare against the field
Rows@NextStringFalseYesIdentifier for the next page of results. Do not set this value manually.

Return to Top