--- schema_version: "1" id: f23c5ee0470ef50d84b1c73d5c92177edb80ae70dc9b9901eea453fb31bee5b8 title: SuiteCRM Connector Objects (suitecrmv4 Schema) collection: developer version: current locale: en-us portal_url: https://docs.salesforce.com/developer/current/en-us/data-cloud/data-cloud-int/guides/suitecrm/c360-a-suitecrm-objects-suitecrmv4.md canonical_url: https://developer.salesforce.com/docs/data/data-cloud-int/guide/c360-a-suitecrm-objects-suitecrmv4.html source_site: developer.salesforce.com content_type: documentation content_hash: b759a26f345a498362491db5dd0e25938fc32662e2c455db580d4d6896ed33aa products: - Data 360 Integration Guide - Data 360 Developer Documentation --- # SuiteCRM Connector Objects (suitecrmv4 Schema) **note:** This feature is a Beta Service. A customer may opt to try a Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at [Agreements and Terms.](https://www.salesforce.com/company/legal/agreements/) If you have questions or feedback about this Beta Service, contact the Data 360 Connector team at [datacloud-connectors-beta@salesforce.com.](mailto:datacloud-connectors-beta@salesforce.com) ## Objects Supported | Name | Description | | ----------------------------------------------------- | ------------------------------------------------------------------------------------------- | | [Accounts](#accounts) | Create, update, delete, and query accounts created in SuiteCRM | | [ACLRoles](#aclroles) | Create, update, delete, and query the ACLRoles table in SuiteCRM | | [Alerts](#alerts) | Create, update, delete, and query the Alerts of your SuiteCRM account | | [Bugs](#bugs) | Create, update, delete, and query the bugs in SuiteCRM | | [BusinessHours](#businesshours) | Create, update, delete, and query business hours information in SuiteCRM | | [Calls](#calls) | Create, update, delete, and query calls in SuiteCRM | | [CallsReschedule](#callsreschedule) | Create, update, delete, and query rescheduled call information for the SuiteCRM calls | | [CampaignLog](#campaignlog) | Create, update, delete, and query logs related to SuiteCRM campaigns | | [Campaigns](#campaigns) | Create, update, delete, and query the SuiteCRM project's campaigns | | [CaseEvents](#caseevents) | Create, update, delete, and query the events related to the SuiteCRM cases | | [Cases](#cases) | Create, update, delete, and query the SuiteCRM cases | | [CaseUpdates](#caseupdates) | Create, update, delete, and query updated made to the SuiteCRM cases | | [Contacts](#contacts) | Create, update, delete, and query the contacts in SuiteCRM | | [Contracts](#contracts) | Create, update, delete, and query contracts in SuiteCRM | | [Currencies](#currencies) | Create, update, delete, and query currencies used in SuiteCRM financial trackings | | [DocumentRevisions](#documentrevisions) | Query and delete revisions to uploaded SuiteCRM documents | | [Documents](#documents) | Create, update, delete, and query SuiteCRM documents | | [EAPM](#eapm) | Create, update, delete, and query the EAPM (External API Module) entries in SuiteCRM | | [EmailAddress](#emailaddress) | Create, update, delete, and query email addresses saved in SuiteCRM | | [Emails](#emails) | Create, update, delete, and query sent or received emails | | [EmailTemplates](#emailtemplates) | Create, update, delete, and query email templates to be used for emails | | [Employees](#employees) | Create, update, delete, and query employees registered in the SuiteCRM project | | [Events](#events) | Create, update, delete, and query events registered in the SuiteCRM project | | [InboundEmail](#inboundemail) | Create, update, delete, and query SuiteCRM inbound emails | | [Index](#index) | Create, update, delete, and query the available indexes in SuiteCRM | | [IndexEvent](#indexevent) | Create, update, delete, and query the Index Event entries in SuiteCRM | | [Invoices](#invoices) | Create, update, delete, and query the invoices saved in the SuiteCRM | | [Leads](#leads) | Create, update, delete, and query the registered Leads | | [LineItemGroups](#lineitemgroups) | Create, update, delete, and query the SuiteCRM line items groups | | [LineItems](#lineitems) | Create, update, delete, and query line items in SuiteCRM | | [Locations](#locations) | Create, update, delete, and query locations in SuiteCRM | | [MapAddressCache](#mapaddresscache) | Create, update, delete, and query information on the Map Address saved in the server cache | | [MapAreas](#mapareas) | Create, update, delete, and query saved map areas in SuiteCRM | | [MapMarkers](#mapmarkers) | Create, update, delete, and query Google Maps Map Markers saved in SuiteCRM | | [Maps](#maps) | Create, update, delete, and query maps via Google Maps. | | [Meetings](#meetings) | Create, update, delete, and query meeting information. | | [Notes](#notes) | Create, update, delete, and query notes in SuiteCRM | | [OAuthConsumerKeys](#oauthconsumerkeys) | Create, update, delete, and query information on OAuth keys distributed by the application. | | [OAuthTokens](#oauthtokens) | Query currently active OAuth tokens | | [Opportunities](#opportunities) | Create, update, delete, and query opportunities saved in SuiteCRM | | [OutboundEmailAccounts](#outboundemailaccounts) | Create, update, delete, and query the outbound email accounts table | | [PDFTemplates](#pdftemplates) | Create, update, delete, and query PDFTemplates table. | | [ProcessAudit](#processaudit) | Create, update, delete, and query information on process audits | | [ProductCategories](#productcategories) | Create, update, delete, and query the product categories. | | [Products](#products) | Create, update, delete, and query the products registered for the SuiteCRM project | | [Projects](#projects) | Create, update, delete, and query projects registered in SuiteCRM | | [ProjectTemplates](#projecttemplates) | Create, update, delete, and query any saved project template. | | [Quotes](#quotes) | Create, update, delete, and query quotes saved in SuiteCRM | | [Releases](#releases) | Create, update, delete, and query the registered releases. | | [ReportCharts](#reportcharts) | Create, update, delete, and query report charts. | | [ReportConditions](#reportconditions) | Create, update, delete, and query report conditions. | | [ReportFields](#reportfields) | Create, update, delete, and query the saved report fields. | | [Reports](#reports) | Create, update, delete, and query information on reports made in SuiteCRM. | | [Roles](#roles) | Create, update, delete, and query the roles in SuiteCRM. | | [SavedSearches](#savedsearches) | Query any saved searches | | [ScheduledReports](#scheduledreports) | Create, update, delete, and query information on SuiteCRM scheduled reports. | | [Schedulers](#schedulers) | Create, update, delete, and query schedulers. | | [SecurityGroupsManagement](#securitygroupsmanagement) | Create, update, delete, and query information on security groups | | [Spots](#spots) | Create, update, delete, and query the saved spots. | | [SuiteCRMFeed](#suitecrmfeed) | Create, update, delete, and query information on the activity feed in the SuiteCRM project. | | [TargetLists](#targetlists) | Create, update, delete, and query the saved target lists. | | [Targets](#targets) | Query targets saved in SuiteCRM | | [Tasks](#tasks) | Create, update, delete, and query tasks in SuiteCRM. | | [TemplateSectionLine](#templatesectionline) | Create, update, delete, and query the template section line entries in SuiteCRM | | [Trackers](#trackers) | Create, update, delete, and query the created trackers. | | [Users](#users) | Create, update, delete, and query the SuiteCRM registered users. | | [WorkFlow](#workflow) | Create, update, delete, and query the wokflow actions in SuiteCRM | | [WorkFlowActions](#workflowactions) | Create, update, delete, and query the wokflow actions in SuiteCRM. | | [WorkFlowConditions](#workflowconditions) | Create, update, delete, and query the workflow conditions in SuiteCRM. | ## Accounts | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------ | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | True | | No | | | Address | String | True | | No | Address from Google Maps of the account address. | | AlternatePhone | String | False | | No | An alternate phone number. | | AnnualRevenue | String | False | | No | Annual revenue for this account. | | AnyEmail | String | True | | No | The email address for the account. | | Assignedto | String | True | [Users.Id](#users) | No | The Id of the user assigned to the record. | | AssignedUser | String | False | | No | The user name of the user assigned to the record. | | BillingCity | String | False | | No | The city used for the billing address. | | BillingCountry | String | False | | No | The country used for the billing address. | | BillingPostalCode | String | False | | No | The postal code used for the billing address. | | BillingState | String | False | | No | The state used for the billing address. | | BillingStreet | String | False | | No | The second line of the billing address. | | BillingStreet2 | String | True | | No | The third line of the billing address. | | BillingStreet3 | String | True | | No | The fourth line of the billing address. | | BillingStreet4 | String | True | | No | The street address used for the billing address. | | Campaign | String | True | | No | The campaign that generated the account. | | CampaignID | String | False | | No | The first campaign name for the account. | | CreatedById | String | True | | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | The full text of the alert. | | EmailAddress | String | False | | No | The alternate email address for the account. | | EmailOptOut | Bool | True | | No | Whether the account has opted out of emails. | | Employees | String | False | | No | Number of employees. Can be a number (100) or range (50-100) | | Fax | String | False | | No | The fax phone number of this account. | | GeocodeStatus | String | True | | No | Geocode from Google Maps of the account address. | | Industry | String | False | | No | The industry that the account belongs in. | | InvalidEmail | Bool | True | | No | Whether the email address of the account has been marked as invalid. | | Latitude | Double | True | | No | Latitude from Google Maps of the account address. | | Longitude | Double | True | | No | Longitude from Google Maps of the account address. | | Memberof | String | False | | No | The name of the parent of this account. | | ModifiedById | String | True | | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Name | String | False | | No | The name of the account. | | NonPrimaryE-mails | String | True | | No | The nonprimary email addresses of the account. | | OfficePhone | String | False | | No | The office phone number. | | Ownership | String | True | | No | The ownership of the account. | | ParentAccountID | String | False | | No | The Id of the parent of this account. | | Rating | String | False | | No | An arbitrary rating for this account for use in comparisons with others. | | ShippingCity | String | False | | No | The city used for the shipping address. | | ShippingCountry | String | False | | No | The country used for the shipping address. | | ShippingPostalCode | String | False | | No | The ZIP code used for the shipping address. | | ShippingState | String | False | | No | The state used for the shipping address. | | ShippingStreet | String | False | | No | The second line of the shipping address. | | ShippingStreet2 | String | True | | No | The third line of the shipping address. | | ShippingStreet3 | String | True | | No | The fourth line of the shipping address. | | ShippingStreet4 | String | True | | No | The street address used for for shipping purposes. | | SICCode | String | False | | No | SIC code of the account. | | TickerSymbol | String | False | | No | The stock trading (ticker) symbol for the account. | | Type | String | False | | No | The type of the account. | | Website | String | False | | No | The URL of the website for the account. | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## ACLRoles | Name | Type | ReadOnly | References | FilterOnly | Description | | -------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the ACL role. | | CreatedById | String | True | [Users.Id](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | The role description. | | ModifiedById | String | True | [Users.Id](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Name | String | False | | No | The role name. | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## Alerts | Name | Type | ReadOnly | References | FilterOnly | Description | | -------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the alert. | | Assignedto | String | False | [Users.ID](#users) | No | The Id of the user assigned to the record. | | AssignedUserId | String | True | | No | The user name of the user assigned to the record. | | CreatedById | String | True | [Users.ID](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | Text of the alert | | IsRead | Bool | False | | No | Whether the alert has been read | | ModifiedById | String | True | [Users.ID](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Name | String | False | | No | Name assigned to the alert | | TargetModule | String | False | | No | Which SuiteCRM module the alert is for | | Type | String | False | | No | Type of alert | | UrlRedirect | String | False | | No | The URL the alert redirects to | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## Bugs | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------ | -------- | -------- | ------------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the record. | | AssignedUserId | String | False | [Users.Id](#users) | No | The Id of the user assigned to the record. | | AssignedUserName | String | True | | No | The user name of the user assigned to the record. | | Category | String | False | | No | Where the bug was discovered (e.g., Accounts, Contacts, or Leads). | | CreatedById | String | True | [Users.Id](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The user who created the record. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | Record deletion indicator. | | Description | String | False | | No | The full text of the note. | | FixedInReleaseId | String | False | [Releases.Id](#releases) | No | The software or service release that corrected the bug. | | FixedInReleaseName | String | True | | No | The name of the software or service release that corrected the bug. | | FoundInReleaseId | String | False | [Releases.Id](#releases) | No | The software or service release that manifested the bug. | | ModifiedById | String | True | [Users.Id](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The user name of the user who last modified the record. | | Number | Int | False | | No | The visual unique identifier. Cannot be updated. | | Priority | String | False | | No | An indication of the priority of the issue. | | ReleaseName | String | True | | No | The release name linked with the bug | | Resolution | String | False | | No | An indication of how the issue was resolved. | | Source | String | False | | No | An indicator of how the bug was entered (e.g., via Web or email). | | Status | String | False | | No | The status of the issue. | | Subject | String | False | | No | The short description of the bug. | | Type | String | False | | No | The type of issue (e.g., issue or feature). | | WorkLog | String | False | | No | Free-form text used to denote activities of interest. | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## BusinessHours | Name | Type | ReadOnly | References | FilterOnly | Description | | -------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the business hour. | | ClosingHours | String | False | | No | Time the business hours ends | | CreatedById | String | True | [Users.ID](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Day | String | False | | No | Which day of the week is the business hour applied for | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | Description for the business hour | | ModifiedById | String | True | [Users.ID](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Name | String | False | | No | Name given to the business hour | | Open | Bool | False | | No | Whether the business hour is open | | OpeningHours | String | False | | No | Time the business hour starts | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## Calls | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------ | -------- | -------- | ------------------------ | ---------- | --------------------------------------------------------------------------------------------------------------------- | | ID [KEY] | String | False | | No | The unique identifier of the call. | | AcceptLink | String | True | | No | The accept status of the call. | | Assignedto | String | False | | No | The user name of the user assigned to the record. | | AssignedUser | String | True | [Users.Id](#users) | No | The Id of the user assigned to the record. | | CallAttemptHistory | String | True | | No | Reschedule info of the call. | | CallAttempts | String | True | | No | The Number of times call was rescheduled. | | Contact | String | True | | No | The contact name for the call. | | Contactid | String | True | [Contacts.Id](#contacts) | No | The Id of the contact for the call. | | CreatedById | String | True | [Users.Id](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The user name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | Record deletion indicator. | | Description | String | False | | No | The full text of the note. | | Direction | String | False | | No | Indicates whether call is inbound or outbound. | | DurationHours | Int | False | | No | The hours portion of the call duration. | | DurationMinutes | Int | False | | No | The minutes portion of the call duration. | | EmailReminder | Bool | True | | No | The checkbox indicating whether or not the email reminder value is set. | | EmailRemindersent | Bool | False | | No | Whether the email reminder is already sent. | | EmailReminderTime | String | False | | No | When a email reminder alert should be issued. -1 means no alert; otherwise, the number of seconds prior to the start. | | EndDate | Datetime | False | | No | The date when the call ends. | | ModifiedById | String | True | [Users.Id](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The user name of the user who last modified the record. | | Name | String | False | | No | A brief description of the call. | | OutlookID | String | False | | No | When the Suite Plug-in for Microsoft Outlook syncs an Outlook appointment, this is the Outlook appointment item Id. | | ParentType | String | False | | No | The type of the parent Sugar object related to the call. | | RecurringSource | String | False | | No | The recurring source requesting the call | | Relatedto | String | True | | No | The name of the parent Sugar object related to the call. | | RelatedtoID | String | False | | No | The Id of the parent Sugar object identified by . | | ReminderChecked | Bool | True | | No | The checkbox indicating whether or not the reminder value is set. | | ReminderTime | String | False | | No | When a reminder alert should be issued. -1 means no alert; otherwise, the number of seconds prior to the start. | | Reminders | String | False | | No | List of reminders for the call | | RepeatCount | Int | False | | No | Number of recurrences. | | RepeatDow | String | False | | No | The days of week in recurrence. | | RepeatInterval | Int | False | | No | The interval of recurrence. | | RepeatParentID | String | False | | No | The Id of the first element of recurring records. | | RepeatType | String | False | | No | The type of recurrence. | | RepeatUntil | Date | False | | No | Repeat until the specified date. | | StartDate | Datetime | False | | No | The date when the call starts. | | Status | String | False | | No | The status of the call (e.g., Held or Not Held). | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## CallsReschedule | Name | Type | ReadOnly | References | FilterOnly | Description | | -------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the call reschedule. | | Assignedto | String | False | | No | The Id of the user assigned to the record. | | AssignedUserId | String | True | | No | The user name of the user assigned to the record. | | Calls | String | False | | No | Name of the rescheduled call | | CallId | String | False | [Calls.Id](#calls) | No | Id of the rescheduled call | | CreatedById | String | True | | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | Description for the call reschedule | | ModifiedById | String | True | | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Name | String | False | | No | Name given for the reschedule | | Reason | String | False | | No | Reason given for the reschedule | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## CampaignLog | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------ | -------- | -------- | ------------------------------ | ---------- | -------------------------------------------------------------------------- | | ID [KEY] | String | False | | No | The unique identifier of the record. | | ActivityDate | Datetime | False | | No | The date the activity occurred. | | ActivityType | String | False | | No | The activity that occurred (e.g., Viewed Message, Bounced, or Opted out). | | Archived | Bool | False | | No | Indicates if the item has been archived. | | campaign_content | String | True | | No | The campaign content. | | campaign_id | String | False | [Campaigns.Id](#campaigns) | No | The identifier of the campaign associated with the campaign log. | | campaign_name | String | True | | No | The name of the campaign associated with the campaign log. | | campaign_objective | String | True | | No | The campaign objective. | | DateModified | Datetime | False | | No | The date the campaign log was last modified. | | Deleted | Bool | False | | No | Record deletion indicator. | | Hits | Int | False | | No | Number of times the item has been invoked (e.g., multiple click throughs). | | LBL_MARKETING_ID | String | False | | No | The Id of the marketing email this entry is associated with. | | marketing_name | String | False | | No | The marketing name. | | MoreInformation | String | False | | No | More information about the campaign log. | | Name | String | True | | No | The name of the campaign associated with the campaign log. | | ProspectListID | String | False | [TargetLists.Id](#targetlists) | No | The prospect list from which the item originated. | | recipient_email | String | True | | No | The email of the recipient. | | recipient_name | String | True | | No | The name of the recipient. | | RelatedId | String | False | | No | The Id of the related record. | | RelatedType | String | False | | No | The type of the related record. | | TargetID | String | False | | No | The identifier of the target record. | | TargetTrackerKey | String | False | | No | The identifier of the tracker URL. | | TargetType | String | False | | No | The target record type (e.g., Contact or Lead). | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## Campaigns | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------ | -------- | -------- | ---------------------------- | ---------- | ------------------------------------------------------------------------------------------------- | | ID [KEY] | String | False | | No | The unique identifier of the campaign. | | ActualCost | Double | False | | No | Actual cost of the campaign. | | AssignedUserId | String | False | [Users.Id](#users) | No | The Id of the user assigned to the record. | | AssignedUserName | String | True | | No | The user name of the user assigned to the record. | | Budget | Double | False | | No | Budgeted amount for the campaign. | | Content | String | False | | No | The campaign description. | | CreatedById | String | True | [Users.Id](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | Currency | String | False | [Currencies.Id](#currencies) | No | Currency in use for the campaign. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | True | | No | The description for the campaign. | | EndDate | Date | False | | No | Ending date of the campaign. | | ExpectedCost | Double | False | | No | Expected cost of the campaign. | | ExpectedRevenue | Double | False | | No | Expected revenue stemming from the campaign. | | Frequency | String | False | | No | Frequency of the campaign. | | Impressions | Int | False | | No | Expected click throughs manually entered by the campaign manager. | | ModifiedById | String | True | [Users.Id](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Name | String | False | | No | The name of the campaign. | | Objective | String | False | | No | The objective of the campaign. | | StartDate | Date | False | | No | Starting date of the campaign. | | Status | String | False | | No | Status of the campaign. | | Tracker | Int | False | | No | The internal Id of the tracker used in a campaign. 2. (See CampaignTrackers.) | | TrackerCount | Int | False | | No | The number of accesses made to the tracker URL; no longer used as of 4.2. (See CampaignTrackers.) | | TrackerLinkText | String | False | | No | The text that appears in the tracker URL. No longer used as of 4.2. (See CampaignTrackers.) | | TrackerRedirectURL | String | False | | No | The URL referenced in the tracker URL. No longer used as of 4.2. (See CampaignTrackers.) | | Type | String | False | | No | The type of the campaign. | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## CaseEvents | Name | Type | ReadOnly | References | FilterOnly | Description | | -------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the case event. | | Assignedto | String | True | | No | The Id of the user assigned to the record. | | AssignedUserId | String | True | | No | The user name of the user assigned to the record. | | CaseId | String | False | [Cases.Id](#cases) | No | The Id of the case the event is logged for | | Case | String | False | | No | The name of the case the event is logged for | | CreatedById | String | True | [Users.Id](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | DateCreated | Datetime | False | | No | | | DateModified | Datetime | False | | No | | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | Description of the case event | | ModifiedById | String | True | [Users.Id](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Name | String | False | | No | Name given for the case update | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## Cases | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------------- | -------- | -------- | ------------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier for the record. | | AccountID | String | False | [Accounts.Id](#accounts) | No | The Id of the associated account. | | AccountName | String | False | | No | The name of the associated account. | | account_name1 | String | True | | No | A second account for the case | | Address | String | True | | No | Address from Google Maps of the case. | | AssignedUserId | String | False | [Users.Id](#users) | No | The user Id assigned to the record. | | AssignedUserName | String | True | | No | The name of the user assigned to the record. | | CaseAttachments | String | True | | No | A display of case attachments | | CaseUpdatesThreaded | String | False | | No | A list of the case updates | | Createdbycontact | String | True | | No | The user name of the user who created the case contact. | | CreatedById | String | False | [Users.Id](#users) | No | The Id of the user who created the record. | | CreatedByName | String | False | | No | The user name of the user who created the record. | | DateCreated | Datetime | False | | No | The date the record was created. | | DateModified | Datetime | False | | No | The date the record was last modified. | | Deleted | Bool | False | | No | Record deletion indicator. | | Description | String | False | | No | The full text of the note. | | GeocodeStatus | String | True | | No | Geocode from Google Maps of the case. | | InternalUpdate | Bool | False | | No | Whether the update is internal. | | Latitude | Double | True | | No | Latitude from Google Maps of the case. | | LBL_CONTACT_CREATED_BY_ID | String | True | [Users.Id](#users) | No | The User that created the case's contact | | Longitude | Double | True | | No | Longitude from Google Maps of the case. | | ModifiedById | String | False | [Users.Id](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | False | | No | The user name who last modified the record. | | Number | Int | False | | No | The user-visible unique identifier for the case. | | Priority | String | False | | No | The priority of the case. | | Resolution | String | False | | No | The resolution of the case. | | State | String | False | | No | State the case is left in | | Status | String | False | | No | The status of the case. | | Subject | String | False | | No | The short description of the bug. | | Suggestions | String | True | | No | Collection of suggestions left for the case. | | Type | String | False | | No | The type of case. | | Updateattachmentform | String | True | | No | The HTML text for the case's update attachment | | UpdateText | String | True | | No | Text associated with an update on the case. | | WorkLog | String | False | | No | Free-form text used to denote activities of interest. | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## CaseUpdates | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------- | -------- | -------- | ------------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the case update. | | Assignedto | String | False | [Users.Id](#users) | No | The Id of the user assigned to the record. | | AssignedUserId | String | True | | No | The user name of the user assigned to the record. | | Case | String | True | | No | The name of the case related to the update | | LBL_CASE_ID | String | False | [Cases.Id](#cases) | No | The name of the case related to the update | | Contact | String | True | | No | Name of the contact related to the update | | LBL_CONTACT_ID | String | False | [Contacts.Id](#contacts) | No | Id of the contact related to the update | | CreatedById | String | True | [Users.Id](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | Description for the case update | | Internal_Update | Bool | False | | No | Whether the update is internal. | | ModifiedById | String | True | [Users.Id](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Name | String | False | | No | Name assigned to the case update | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## Contacts | Name | Type | ReadOnly | References | FilterOnly | Description | | ---------------------------- | -------- | -------- | ---------------------- | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier for the record. | | AcceptStatus | String | True | | No | Id of the event status | | AcceptStatusC | String | True | | No | The call accept status fields. | | AcceptStatusId | String | True | | No | The Id of the accept status. | | AcceptStatusM | String | True | | No | The meeting accept status fields. | | AcceptStatusName | String | True | | No | The name of the accept status. | | AccountDisabled | Bool | False | | No | Whether the portal account has been disabled for the contact. | | AccountID | String | True | | No | The Id of the account associated with the contact. | | AccountName | String | True | | No | The name of the account associated with the contact. | | Address | String | True | | No | Address from Google Maps of the contact. | | AlternateAddressCity | String | False | | No | The city for the alternate address. | | AlternateAddressCountry | String | False | | No | The country for the alternate address. | | AlternateAddressPostal_Code | String | False | | No | The postal code for the alternate address. | | AlternateAddressState | String | False | | No | The state for the alternate address. | | AlternateAddressStreet | String | False | | No | The street address for the alternate address. | | AlternateAddressStreet2 | String | True | | No | The second line of the alternate address. | | AlternateAddressStreet3 | String | True | | No | The third line of the alternate address. | | AnyEmail | String | True | | No | The email for the contact. | | Assignedto | String | True | | No | The name of the user assigned to the record. | | AssignedUser | String | False | [Users.Id](#users) | No | The user Id assigned to the record. | | Assistant | String | False | | No | The name of the assistant of the contact. | | AssistantPhone | String | False | | No | The phone number of the assistant of the contact. | | Birthdate | Date | False | | No | The birthdate of the contact. | | Campaign | String | False | | No | The first campaign name for Contact. | | CampaignID | String | False | | No | The campaign that generated the lead. | | CreatedById | String | False | [Users.Id](#users) | No | The Id of the user who created the record. | | CreatedByName | String | False | | No | The name of the user who created the record. | | DateCreated | Datetime | False | | No | The date the record was created. | | DateModified | Datetime | False | | No | The date the record was last modified. | | Deleted | Bool | False | | No | Record deletion indicator. | | Department | String | False | | No | The department of the contact. | | Description | String | False | | No | The full text of the note. | | DoNotCall | Bool | False | | No | An indicator of whether the contact can be called. | | Email | String | True | | No | The email and name of the contact. | | EmailAddress | String | False | | No | The alternate email for the contact. | | EmailOptOut | Bool | True | | No | Whether the contact has opted out of emails. | | Fax | String | False | | No | The contact fax number. | | FirstName | String | False | | No | The first name of the contact. | | Fullname | String | True | | No | The full name of hte contact. | | GeocodeStatus | String | True | | No | Geocode from Google Maps of the contact. | | Home | String | False | | No | Home phone number of the contact. | | InvalidEmail | Bool | True | | No | Whether the contact email has been marked as invalid. | | JoomlaAccountID | String | False | | No | Id of the contact's Joomla account. | | LastName | String | False | | No | The last name of the contact. | | Latitude | Double | True | | No | Latitude from Google Maps of the contact. | | LBL_CONT_ACCEPT_STATUS | String | True | | No | The event accept status fields. | | LBL_CONT_INVITE_STATUS | String | True | | No | The event invite status fields. | | LBL_JOOMLA_ACCOUNT_ACCESS | String | True | | No | Access point for the contact's Joomla account. | | LBL_LIST_ACCEPT_STATUS_EVENT | String | True | | No | Accept status for the event | | LBL_LIST_INVITE_STATUS | String | True | | No | Id for the event invite | | LBL_LIST_INVITE_STATUS_EVENT | String | True | | No | Invite status of the event | | LeadSource | String | False | | No | The lead source for the contact. | | Longitude | Double | True | | No | Longitude from Google Maps of the contact. | | Mobile | String | False | | No | Mobile phone number of the contact. | | ModifiedById | String | False | [Users.Id](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The user name of the user who last modified the record. | | Name | String | True | | No | The name of the contact. | | NonPrimaryEmails | String | True | | No | The nonprimary email addresses for the contact. | | OfficePhone | String | False | | No | Work phone number of the contact. | | OpportunityRole | String | True | | No | The opportunity role. | | OpportunityRoleFields | String | True | | No | The opportunity role fields. | | OpportunityRoleID | String | True | | No | The Id of the opportunity role. | | OtherEmail | String | True | | No | The alternate email for the contact. | | OtherPhone | String | False | | No | Other phone number for the contact. | | Photo | String | False | | No | The avatar for the contact. | | PortalUserType | String | False | | No | Type of the contact's portal account. | | PrimaryAddressCity | String | False | | No | The city for the primary address. | | PrimaryAddressCountry | String | False | | No | The country for primary address. | | PrimaryAddressPostalCode | String | False | | No | The postal code for the primary address. | | PrimaryAddressState | String | False | | No | The state for the primary address. | | PrimaryAddressStreet | String | False | | No | The street address for the alternate address. | | PrimaryAddressStreet2 | String | True | | No | The second line of the alternate address. | | PrimaryAddressStreet3 | String | True | | No | The third line of the alternate address. | | ReportsTo | String | True | | No | The name of the contact this contact reports to. | | ReportstoID | String | False | [Reports.Id](#reports) | No | The Id of the contact this contact reports to. | | Salutation | String | False | | No | The contact salutation (e.g., Mr. or Ms.). | | SynctoOutlook*reg* | Bool | True | | No | Whether the lead is synced to Outlook. | | Title | String | False | | No | The title of the contact. | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## Contracts | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------------------ | -------- | -------- | ---------------------------------- | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the contract. | | Account | String | False | | No | Account opened for the contract | | AssignedUserId | String | True | [Users.Id](#users) | No | The Id of the contract manager. | | ContractManager | String | False | | No | Name of the account manager | | Call_ID | String | False | [Call.Id](#calls) | No | Id of the call linked to the contract | | CompanySignedDate | Date | False | | No | Date the company signed the contract | | Contact | String | True | | No | Name of the contact linked to the account | | Contact_Id | String | False | [Contacts.Id](#contacts) | No | Id of the contact linked to the account | | ContractTitle | String | False | | No | Title given to the contract | | ContractType | String | False | | No | Type of the contract | | ContractValue | Double | False | | No | Value of the contract | | ContractValue(DefaultCurrency) | Double | False | | No | Value of the contract calculated in the system's default currency | | Contract_Account_Id | String | True | [Accounts.Id](#accounts) | No | Id of the Account linked to the contract | | CreatedById | String | True | [Users.Id](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | Currency | String | False | | No | Id of the currency used in the contract | | CustomerSignedDate | Date | False | | No | Date the customer signed the contract | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | Description for the contract | | Discount | Double | False | | No | Discount value for the account | | Discount(DefaultCurrency) | Double | False | | No | Discount value for the account in the system's default currency | | EndDate | Date | False | | No | Date until the contract expires | | GrandTotal | Double | False | | No | Grand total of the account | | GrandTotal(DefaultCurrency) | Double | False | | No | Grand total of the account in the system's currency | | LineItems | String | True | | No | Line items of the contract | | ModifiedById | String | True | [Users.Id](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Opportunity | String | True | | No | Name of the opportunity linked to the contract | | Opportunity_Id | String | False | [Opportunities.Id](#opportunities) | No | Id of the opportunity linked to the contract | | ReferenceCode | String | False | | No | Reference code of the contract | | RenewalReminderDate | Datetime | False | | No | Date to remind for the contract renewal | | Shipping | Double | False | | No | Shipping costs of the contract | | Shipping(DefaultCurrency) | Double | False | | No | Shipping costs of the contract in the system's default currency | | ShippingTax | String | False | | No | Shipping tax costs | | ShippingTax(DefaultCurrency) | Double | False | | No | Shipping tax costs in the system's default currency | | ShippingTaxAmount | Double | False | | No | Amount of the shipping tax | | StartDate | Date | False | | No | Date the contract is valid from | | Status | String | False | | No | Status of the contract | | Subtotal | Double | False | | No | Subtotal amount | | Subtotal(DefaultCurrency) | Double | False | | No | Subtotal amount in the system's default currency | | Tax | Double | False | | No | Tax costs | | Tax(DefaultCurrency) | Double | False | | No | Tax costs in the system's default currency | | Total | Double | False | | No | Total value of the contract | | Total(DefaultCurrency) | Double | False | | No | Total value of the contract in the system's default currency | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## Currencies | Name | Type | ReadOnly | References | FilterOnly | Description | | -------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | Id [KEY] | String | False | | No | The unique identifer of the currency. | | ConversionRate | Double | False | | No | Conversion rate factor (relative to stored value). | | CreatedById | String | False | [Users.Id](#users) | No | Id of the user who created the record. | | CreatedByName | String | False | | No | Id of the user who created the record. | | CurrencyName | String | False | | No | Name of the currency. | | CurrencySymbol | String | False | | No | Symbol representing the currency. | | DateCreated | Datetime | False | | No | Date the record was created. | | DateModified | Datetime | False | | No | Date the record was last modified. | | Deleted | Bool | False | | No | Record deletion indicator. | | hide | String | True | | No | Hide status of the currency | | ISO4217Code | String | False | | No | 3-letter identifier specified by ISO 4217 (e.g., USD). | | Status | String | False | | No | Currency status. | | unhide | String | True | | No | Unhide status of the currency | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## DocumentRevisions | Name | Type | ReadOnly | References | FilterOnly | Description | | -------------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | RevisionNumber [KEY] | String | False | | No | The unique identifier for the document revision. | | ChangeLog | String | False | | No | The change log for the document revision. | | CreatedById | String | True | [Users.Id](#users) | No | The Id of the user who created the document. | | CreatedByName | String | True | | No | The name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the revision was entered. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | Whether the document revision is deleted. | | DocumentName | String | True | | No | The name of the document. | | DocumentSourceID | String | False | | No | The document Id from the Web service provider for the document. | | DocumentSourceURL | String | False | | No | The document URL from the Web service provider for the document. | | File | String | False | | No | The file name of the document. | | FileExtension | String | False | | No | The file extension of the document. | | LastRevisionId | String | True | | No | The Id of the latest revision. | | LatestRevision | String | True | | No | The latest revision. | | MimeType | String | False | | No | The MIME type of the document. | | RelatedDocument | String | False | | No | The Id for the associated document. | | Revision | String | False | | No | The revision number. | | Source | String | False | | No | The document type (e.g., Google, box.net, or IBM SmartCloud). | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## Documents | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------------- | -------- | -------- | -------------------------- | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier for the record. | | Assignedto | String | True | | No | The user name of the user assigned to the record. | | AssignedUserId | String | False | [Users.Id](#users) | No | The Id of the user assigned to the record. | | Category | String | False | | No | The Id for the category of the document. | | Contractname | String | True | | No | The name of the document's contract | | Contractstatus | String | True | | No | The document's contract status. | | CreatedById | String | True | [Users.Id](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The user name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | Record deletion indicator. | | Description | String | False | | No | The full text of the note. | | DocumentName | String | False | | No | The document name. | | DocumentRevisionId | String | False | | No | The Id of the document revision. | | DocumentSourceID | String | False | | No | The document Id from the Web service provider for the document. | | DocumentSourceURL | String | False | | No | The document URL from the Web service provider for the document. | | DocumentType | String | False | | No | The template type of the document. | | ExpirationDate | Date | False | | No | The date the document expires. | | FileName | String | True | | No | The file name of the document attachment. | | IsaTemplate | Bool | False | | No | Whether the document is a template. | | LastRevisionCreateDate | Date | True | | No | The date the last revision was created. | | LastrevisionMIMEtype | String | True | | No | The MIME type of the last revision. | | Lastestrevisionname | String | True | | No | The name of the latest revision. | | LatestRevision | String | True | | No | The latest revision. | | LatestRevisionId | String | True | | No | The Id of the latest revision. | | Linkedid | String | True | | No | The Id of the linked record. | | ModifiedById | String | True | [Users.Id](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The user name of the user who last modified the record. | | Name | String | True | | No | The name of the document. | | PublishDate | Date | False | | No | The date the document is active. | | RelatedDocument | String | True | | No | The related document name. | | RelatedDocumentID | String | False | [Documents.Id](#documents) | No | The Id of the related document. | | RelatedDocumentRevision | String | True | | No | The related document version number. | | RelatedDocumentRevisionID | String | False | | No | The Id of the related document revision. | | Revision | String | True | | No | The revision number. | | RevisionCreatedBy | String | True | | No | The name of the user who created the last revision. | | Selectedrevisionfilename | String | True | | No | The filename of the selected revision. | | Selectedrevisionid | String | True | | No | The Id of the selected revision. | | Selectedrevisionname | String | True | | No | The name of the selected revision. | | Source | String | False | | No | The document type (e.g., Google, box.net, or IBM SmartCloud). | | Status | String | True | | No | The document status. | | StatusId | String | False | | No | The Id of the document status. | | SubCategory | String | False | | No | The Id of the subcategory of the document. | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## EAPM | Name | Type | ReadOnly | References | FilterOnly | Description | | -------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------- | | ID [KEY] | String | False | | No | Unique identifier for the external API. | | APIData | String | False | | No | Any API data that the external API may wish to store on a per-user basis. | | AppPassword | String | False | | No | The password of the external API. | | AppUserName | String | False | | No | The name of the external API. | | Application | String | False | | No | The application name of the external API. | | AssignedUserId | String | False | [Users.Id](#users) | No | The Id of the user assigned to the record. | | Connected | Bool | False | | No | Whether the external API has been validated. | | ConsumerKey | String | False | | No | The consumer key for the external API. | | ConsumerSecret | String | False | | No | The consumer secret for the external API. | | CreatedById | String | True | [Users.Id](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | The full text of the note. | | ModifiedById | String | True | [Users.Id](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The user name of the user who last modified the record. | | OAuthToken | String | False | | No | The OAuth access token for the external API. | | PleaseNote | String | True | | No | The note for the external API. | | SuiteCRMUser | String | True | | No | The name of the user assigned to the record. | | URL | String | False | | No | The URL of the external API. | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## EmailAddress | Name | Type | ReadOnly | References | FilterOnly | Description | | ---------------- | -------- | -------- | ---------- | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the email address. | | DateCreate | Datetime | True | | No | The date the email address was created. | | DateModified | Datetime | True | | No | The date the email address was last modified. | | Delete | Bool | False | | No | Whether the email address is deleted. | | EmailAddress | String | False | | No | The email address. | | EmailAddresscaps | String | False | | No | The email address in uppercase. | | InvalidEmail | Bool | False | | No | Whether the email address is marked as invalid. | | OptedOut | Bool | False | | No | Whether the email address is marked as opt out. | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## Emails | Name | Type | ReadOnly | References | FilterOnly | Description | | ---------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------------------------------------------- | | ID [KEY] | String | False | | No | The unique identifier of the email. | | Assignedto | String | True | | No | The user name of the user assigned to the record. | | AssignedUserId | String | False | [Users.Id](#users) | No | The Id of the user assigned to the record. | | bcc_addrs_names | String | True | | No | The bcc addresses in the email. | | CC_Addrs_names | String | True | | No | The cc addresses in the email. | | CreatedById | String | True | [Users.Id](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The user name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | DateSent | Datetime | False | | No | The date the email was sent. | | Deleted | Bool | False | | No | The record deletion indicator. | | description | String | True | | No | The description for the email. | | description_html | String | True | | No | The HTML description for the email. | | EmailStatus | String | False | | No | The status of the email. | | Flagged | Bool | False | | No | The flagged status of the email. | | from_addr_name | String | True | | No | The from address in the email. | | Intent | String | False | | No | The target of the action used in the Inbound Email assignment. | | LBL_MAILBOX_ID | String | False | | No | The Id of the mailbox associated with the email. | | MessageID | String | False | | No | The Id of the email item obtained from the email transport system. | | ModifiedById | String | True | [Users.Id](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The user name of the user who last modified the record. | | Name | String | False | | No | The subject of the email. | | Parent_ID | String | False | | No | The Id of the Sugar module associated with the email. (Deprecated as of 4.2.) | | Parent_Name | String | True | | No | The name of the Sugar module associated with the email. | | Parent_Type | String | False | | No | The type of the Sugar module associated with the email. (Deprecated as of 4.2.) | | raw_source | String | True | | No | The raw source for the email. | | ReplyToStatus | Bool | False | | No | The reply-to status of the email. If you reply to an email then the reply-to status of original email is set. | | reply_to_addr | String | True | | No | The reply-to address in the email. | | to_addrs_names | String | True | | No | The to addresses in the email. | | Type | String | False | | No | The type of the email (e.g., draft). | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## EmailTemplates | Name | Type | ReadOnly | References | FilterOnly | Description | | ---------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the email template. | | AssignedUserId | String | False | [Users.Id](#users) | No | The Id of the user assigned to the record. | | AssignedUserName | String | False | | No | The user name of the user assigned to the record. | | Body | String | False | | No | Plaintext body of the resulting email. | | CreatedById | String | True | [Users.Id](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | The description for the email template. | | ModifiedById | String | True | [Users.Id](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Name | String | False | | No | The name of the email template. | | PlainText | String | False | | No | The HTML-formatted body of the resulting email. | | Published | Bool | False | | No | The published status of the record. | | Subject | String | False | | No | The subject of the resulting email. | | TextOnly | Bool | False | | No | Whether the email template is to be sent in text only. | | Type | String | False | | No | The type of the email template. | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## Employees | Name | Type | ReadOnly | References | FilterOnly | Description | | -------------------------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the employee. | | AcceptStatusC | String | True | | No | The status fields for the call accept status of the employee. | | AcceptStatusId | String | True | | No | The Id of the accept status of the employee. | | AcceptStatusM | String | True | | No | The status fields for the meeting accept status of the employee. | | AcceptStatusName | String | True | | No | The name of the accept status of the employee. | | AddressCity | String | False | | No | The city in the address of the employee. | | AddressCountry | String | False | | No | The country in the address of the employee. | | AddressPostalCode | String | False | | No | The postal code in the address of the employee. | | AddressState | String | False | | No | The state in the address of the employee. | | AddressStreet | String | False | | No | The street address of the employee. | | AuthenticationId | String | False | | No | The Id used in authentication. | | CreatedBy | String | True | [Users.Id](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The user name of the user who created the record. | | DateEntered | Datetime | True | | No | The date the employee record was entered into the system. | | DateModified | Datetime | True | | No | The date the employee record was last modified. | | Deleted | Bool | False | | No | Whether the employee is deleted. | | Department | String | False | | No | The department of the employee. | | Description | String | False | | No | The description for the employee. | | DisplayEmployeeRecord | Bool | False | | No | Whether to show the employee. | | EmailAddress | String | True | | No | The alternate email address of the employee. | | EmailClient | String | True | | No | The link type of the email for the employee. | | EmployeeStatus | String | False | | No | The status of the employee. | | ExternalAuthentication | Bool | False | | No | Whether the employee only has external authentication available. | | Fax | String | False | | No | The fax of the employee. | | FirstName | String | False | | No | The first name of the employee. | | Fullname | String | True | | No | The full name of the employee. | | GroupUser | Bool | False | | No | Whether the employee is a group user. | | HomePhone | String | False | | No | The home phone number of the employee. | | IMName | String | False | | No | The Id of the instant messenger service used by the employee. | | IMType | String | False | | No | The type of the instant messenger service used by the employee. | | IsAdministrator | Bool | False | | No | Whether the employee is an admin. | | IsUser | Bool | False | | No | Whether the employee has a Sugar login. | | LastName | String | False | | No | The last name of the employee. | | LBL_PRIMARY_GROUP | Bool | True | | No | The primary security group the employee is assigned to. | | LBL_REPORTS_TO_ID | String | False | | No | The Id of who the employee reports to. | | LBL_securitygroup_noninherit_id | String | True | | No | The security group's non-inheritance id. | | LBL_SECURITYGROUP_NONINHERITABLE | Bool | True | | No | Whether the group is non inheritable. | | Mobile | String | False | | No | The mobile phone number of the employee. | | ModifiedById | String | True | [Users.Id](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The user name of the user who last modified the record. | | Name | String | False | | No | The name of the employee. | | NotifyonAssignment | Bool | False | | No | Whether the employee can receive notifications. | | Other | String | False | | No | The alternate phone of the employee. | | Password | String | False | | No | The user hash of the employee. | | Password_Last_Changed | Datetime | False | | No | The date the password of the employee was last changed. | | Photo | String | False | | No | The Id of the picture. | | PortalAPIUser | Bool | False | | No | Whether the employee is a portal-only user. | | Reportsto | String | True | | No | The user name of who the employee reports to. | | SecurityGroup | String | True | | No | The security group's fields that are selected for non-inheritance. | | Status | String | False | | No | The status of the employee. | | SystemGeneratedPassword | Bool | False | | No | Whether the employee has a system-generated password. | | Title | String | False | | No | The title of the employee. | | UserName | String | False | | No | The username of the employee. | | UserType | String | True | | No | The user type of the employee. | | WorkPhone | String | False | | No | The work phone number of the employee. | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## Events | Name | Type | ReadOnly | References | FilterOnly | Description | | -------------------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the event. | | AcceptRedirectURL | String | False | | No | The URL to redirect to if the event is accepted | | ActivityStatus | String | False | | No | Status type of the event activity | | Assignedto | String | True | | No | The user name of the user assigned to the record. | | AssignedUserId | String | False | [Users.ID](#users) | No | The Id of the user assigned to the record. | | Budget | Double | False | | No | Budget set for the event | | CreatedById | String | True | [Users.ID](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | Currency | String | False | | No | Id of the currency used in the budget | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | DeclineRedirect_URL | String | False | | No | The URL to redirect to if the event is declined | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | Description given for the event | | Duration | String | True | | No | Complete duration of the event | | DurationHours | Int | False | | No | Number of hours the event lasts | | DurationMinutes | Int | False | | No | Number of minutes the event lasts | | EmailInviteTemplate | String | False | | No | Template for an email invite | | EndDate | Datetime | False | | No | Date the event ends | | LBL_RESPONSE_LINK | String | True | | No | Url that accepts the event invitation | | LBL_RESPONSE_LINK_DECLINED | String | True | | No | URL that declines the event invitation | | Locations | String | True | | No | Locations the event will take place | | ModifiedById | String | True | [Users.ID](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Name | String | False | | No | Name given to the event | | StartDate | Datetime | False | | No | Date the event starts | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## InboundEmail | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------------------- | -------- | -------- | -------------------------------------- | ---------- | ------------------------------------------------------------------------ | | Id [KEY] | String | False | | No | The unique identifier of the inbound email. | | Auto-ReplyTemplate | String | False | [Email Templates.Id](#email templates) | No | The inbound email's auto-reply template | | CreatedById | String | True | [Users.ID](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | DeleteReadEmailsAfterImport | Bool | False | | No | Whether the emails are deleted after an import | | Deleted | Bool | False | | No | The record deletion indicator. | | GroupFolderId | String | False | | No | Id of the group's folder linked to the email | | LBL_GROUP_ID | String | False | | No | Group Id linked to the email | | LBL_SERVICE | String | False | | No | Service type of the inbound email | | LBL_STORED_OPTIONS | String | False | | No | Stored options of the inbound email | | MailServerAddress | String | False | | No | URL of the mail server to retrieve inbound emails from | | MailServerProtocol | Int | False | | No | Mail protocol of the mail server | | ModifiedById | String | True | [Users.ID](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | MonitoredFolders | String | False | | No | Folders monitored from the mail server | | Name | String | False | | No | name of the inbound email | | Password | String | False | | No | Authentication password required to access the mail server | | Personal | Bool | False | | No | Whether the inbound email is personal | | PossibleActions | String | False | | No | The mail server's mailbox type | | Status | String | False | | No | Status of the inbound email | | UserName | String | False | | No | SMTP Username to connect to the mail server | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## Index | Name | Type | ReadOnly | References | FilterOnly | Description | | -------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the index. | | Assignedto | String | True | | No | The user name of the user assigned to the record. | | AssignedUserId | String | False | [Users.Id](#users) | No | The Id of the user assigned to the record. | | CreatedById | String | True | [Users.ID](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | Description for the index | | LastOptimised | Datetime | True | | No | Date when the index was last optimized | | Location | String | False | | No | Module where the index is applicable | | ModifiedById | String | True | [Users.ID](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Name | String | False | | No | Name given to te index | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## IndexEvent | Name | Type | ReadOnly | References | FilterOnly | Description | | -------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the index event. | | RecordId | String | False | | No | Which record produced the event | | RecordModule | String | False | | No | Which module does the record exist in | | Error | String | False | | No | Message of the event's recorded error | | Assignedto | String | True | | No | The user name of the user assigned to the record. | | AssignedUserId | String | False | [Users.Id](#users) | No | The Id of the user assigned to the record. | | CreatedById | String | True | [Users.ID](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | Description of the indexs event | | ModifiedById | String | True | [Users.ID](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Name | String | False | | No | Title of the index event | | Success | Bool | False | | No | Whether the index event is successful | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## Invoices | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------------------- | -------- | -------- | ------------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the invoice. | | Account | String | True | | No | Billing account for the invoice | | Assignedto | String | True | | No | The user name of the user assigned to the record. | | AssignedUserId | String | False | [Users.Id](#users) | No | The Id of the user assigned to the record. | | BillingCity | String | False | | No | City where the billing account is recorded in | | BillingCountry | String | False | | No | Country where the billing account is recorded in | | BillingPostalCode | String | False | | No | Postal code of the billing account | | BillingState | String | False | | No | State where the billing account is recorded in | | BillingStreet | String | False | | No | Street where the billing account is recorded in | | billing_account_id | String | False | [Accounts.Id](#accounts) | No | Id of the billing account | | billing_contact_id | String | False | [Contacts.Id](#contacts) | No | Id of the billing contact | | Contact | String | True | | No | Name of the billing contact | | CreatedById | String | True | [Users.ID](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | Currency | String | False | | No | Id of the currency used for currency values | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | Description provided for the | | Discount | Double | False | | No | Discount amount of the invoice | | LBL_DISCOUNT\_\_AMOUNT_USDOLLAR | Double | False | | No | Discount amount of the invoice in the system's default currency | | DueDate | Date | False | | No | Due date of the invoice | | GrandTotal | Double | True | | No | The invoice's grand total | | GrandTotal(DefaultCurrency) | Double | True | | No | The invoice's grand total in the system's default currency | | InvoiceDate | Date | False | | No | Date the invoice was issued | | InvoiceNumber | Int | False | | No | Number of the invoice | | InvoiceTemplates | String | False | | No | Template applying to the invoice | | LineItems | String | True | | No | The invoice's list of line items | | ModifiedById | String | True | [Users.ID](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | QuoteDate | Date | False | | No | Date of the invoice quote | | QuoteNumber | Int | False | | No | Number of the invoice quote | | Shipping | Double | False | | No | Shipping costs | | Shipping(DefaultCurrency) | Double | False | | No | Shipping costs in the system's default currency | | ShippingCity | String | False | | No | City of the shipping destination | | ShippingCountry | String | False | | No | Country of the shipping destination | | ShippingPostalCode | String | False | | No | Postal Code of the shipping destination | | ShippingState | String | False | | No | State of the shipping destination | | ShippingStreet | String | False | | No | Address of the shipping destination | | ShippingTax | String | False | | No | Shipping tax costs | | ShippingTax(DefaultCurrency) | Double | False | | No | Shipping tax costs in the system's default currency | | ShippingTaxAmount | Double | False | | No | Amount of te shipping tax | | Status | String | False | | No | Status of the invoice | | Subtotal | Double | True | | No | Subtotal amount in the invoice | | Subtotal(DefaultCurrency) | Double | True | | No | Subtotal amount in the invoice in the system's default currency | | Subtotal+Tax | Double | True | | No | Subtotal and tax amount in the invoice | | SubtotalTaxAmount | Double | True | | No | Subtotal and tax amount in the invoice in the system's default currency | | Tax | Double | False | | No | Tax costs in the invoice | | Tax(DefaultCurrency) | Double | False | | No | Tax costs in the invoice in the system's default currency | | Title | String | False | | No | Title assigned to the invoice | | Total | Double | True | | No | Total amount in the invoice | | Total(DefaultCurrency) | Double | True | | No | Total amount in the invoice in the system's default currency | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## Leads | Name | Type | ReadOnly | References | FilterOnly | Description | | ---------------------------- | -------- | -------- | ---------------------------------- | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the record. | | AcceptStatusC | String | True | | No | The call accept status fields. | | AcceptStatusId | String | True | | No | The Id of the accept status. | | AcceptStatusM | String | True | | No | The meeting accept status fields. | | AcceptStatusName | String | True | | No | The name of the accept status. | | AccountDescription | String | False | | No | Description for the lead's account | | AccountID | String | False | [Accounts.Id](#accounts) | No | Account the lead is linked to | | AccountName | String | False | | No | The name of the associated acocunt. | | Address | String | True | | No | Address from Google Maps of the lead. | | AltAddressCity | String | False | | No | The city for the alternate address. | | AltAddressCountry | String | False | | No | The country for the alternate address. | | AltAddressPostalcode | String | False | | No | The postal code for the alternate address. | | AltAddressState | String | False | | No | The state for the alternate address. | | AltAddressStreet | String | False | | No | The street address for the alternate address. | | AltAddressStreet2 | String | True | | No | The second line of the alternate address. | | AltAddressStreet3 | String | True | | No | The third line of the alternate address. | | AnyEmail | String | True | | No | The email for the lead. | | Assignedto | String | True | | No | The user name of the user assigned to the record. | | AssignedUser | String | False | [Users.Id](#users) | No | User Id assigned to the record. | | Assistant | String | False | | No | The name of the assistant of the lead. | | AssistantPhone | String | False | | No | The phone number of the assistant of the lead. | | Birthdate | Date | False | | No | The birthdate of the lead. | | Campaign | String | True | | No | The lead's campaign name | | CampaignID | String | False | [Campaigns.Id](#campaigns) | No | Campaign that generated the lead. | | ContactID | String | False | [Contacts.Id](#contacts) | No | Main contact for the lead | | Converted | Bool | False | | No | Whether the lead has been converted. | | CreatedById | String | True | [Users.Id](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The user name of the user who created the record. | | DateCreated | Datetime | True | | No | Date the record was created. | | DateModified | Datetime | True | | No | Date the record was last modified. | | Deleted | Bool | False | | No | Record deletion indicator. | | Department | String | False | | No | The department of the lead. | | Description | String | False | | No | Full text of the note. | | DoNotCall | Bool | False | | No | An indicator of whether the lead can be called. | | EmailAddress | String | False | | No | The alternate email for the lead. | | EmailAddress2 | String | True | | No | Email of WebToLead | | EmailOptOut | Bool | True | | No | Whether the lead has opted out of radio. | | EmailOptOut2 | Bool | True | | No | Whether the prospect has opted out of WebToLead emails. | | EventStatusId | String | True | | No | Id of the lead's event status. | | Fax | String | False | | No | The lead fax number. | | FirstName | String | False | | No | The first name of the lead. | | Fullname | String | True | | No | The full name of the lead. | | GeocodeStatus | String | True | | No | Google Maps geocode status | | HomePhone | String | False | | No | Home phone number of the lead. | | InvalidEmail | Bool | True | | No | Whether the lead email has been marked as invalid. | | LastName | String | False | | No | The last name of the lead. | | Latitude | Double | True | | No | Latitude from Google Maps of the lead. | | LBL_CONT_ACCEPT_STATUS | String | True | | No | The event accept status fields. | | LBL_CONT_INVITE_STATUS | String | True | | No | The event invite status fields. | | LBL_LIST_ACCEPT_STATUS_EVENT | String | True | | No | Status of the lead's event accept. | | LBL_LIST_INVITE_STATUS | String | True | | No | Id of the lead's event invite. | | LBL_LIST_INVITE_STATUS_EVENT | String | True | | No | Name of the lead's event status. | | LeadInvalidEmail | Bool | True | | No | Whether the WebToLead email is invalid. | | LeadSource | String | False | | No | How the lead came to be known. | | LeadSourceDescription | String | False | | No | Description of the lead source. | | Longitude | Double | True | | No | Longitude from Google Maps of the lead. | | Mobile | String | False | | No | Mobile phone number of the lead. | | ModifiedById | String | True | [Users.Id](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The user name of the user who last modified the record. | | Name | String | True | | No | The name of the lead. | | NonPrimaryE-mails | String | True | | No | The nonprimary email addresses for the lead. | | OfficePhone | String | False | | No | Work phone number of the lead. | | OpportunityAmount | String | False | | No | The amount the opportunity yields | | OpportunityID | String | False | [Opportunities.Id](#opportunities) | No | The Opportunity the lead was generated from | | OpportunityName | String | False | | No | The name of the opportunity the lead was generated from | | OtherEmail | String | True | | No | The alternate email for the lead. | | OtherEmail2 | String | True | | No | Alternate email of WebToLead | | OtherPhone | String | False | | No | Other phone number for the lead. | | Photo | String | False | | No | The picture for the lead. | | PortalApplication | String | False | | No | The Joomla portal application of the lead | | PortalName | String | False | | No | The Joomla portal name of the lead | | PrimaryAddressCity | String | False | | No | The city for the primary address. | | PrimaryAddressCountry | String | False | | No | The country for the primary address. | | PrimaryAddressPostalcode | String | False | | No | The postal code for the primary address. | | PrimaryAddressState | String | False | | No | The state for the primary address. | | PrimaryAddressStreet | String | False | | No | The street address used for the primary address. | | PrimaryAddressStreet2 | String | True | | No | The second line of the primary address. | | PrimaryAddressStreet3 | String | True | | No | The third line of the primary addrss. | | ReferredBy | String | False | | No | The Name of the lead's reference. | | ReportsTo | String | True | | No | The name the updates for the lead will be reported to | | ReportsToID | String | False | [Employees.Id](#employees) | No | The name the updates for the lead will be reported to | | Salutation | String | False | | No | The lead salutation (e.g., Mr. or Ms.). | | Status | String | False | | No | Status of the lead | | StatusDescription | String | False | | No | A description for the status | | Title | String | False | | No | The title of the lead. | | Website | String | False | | No | The lead's website | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## LineItemGroups | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the line items group. | | Assignedto | String | True | | No | The user name of the user assigned to the record. | | AssignedUserId | String | False | [Users.Id](#users) | No | The Id of the user assigned to the record. | | CreatedById | String | True | [Users.ID](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | Currency | String | False | | No | Id of the currency used for currency values | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | Description for the line items group | | Discount | Double | False | | No | Group's discount value | | Discount(DefaultCurrency) | Double | True | | No | Group's discount value in the system's default currency | | GroupName | String | False | | No | Name assigned to the line items group | | GroupTotal | Double | True | | No | Group's total amount | | GroupTotal(DefaultCurrency) | Double | True | | No | Group's total amount in the system's default currency | | ModifiedById | String | True | [Users.ID](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Number | Int | False | | No | Number assigned to the group | | LBL_PARENT_ID | String | False | | No | Parent record of this group | | LBL_FLEX_RELATE | String | True | | No | Group's parent name | | ParentType | String | False | | No | Parent't type of this group | | Subtotal | Double | False | | No | Group's subtotal amount | | Subtotal(DefaultCurrency) | Double | False | | No | Group's subtotal amount in the system's default currency | | SubtotalTax | Double | True | | No | Group's subtotal and amount | | SubtotalTaxAmount | Double | True | | No | Group's subtotaland tax amount in the system's default currency | | Tax | Double | False | | No | Group's tax amount | | Tax(DefaultCurrency) | Double | True | | No | Group's tax amount in the system's default currency | | Total | Double | True | | No | Group's total amount in the system's default currency | | Total(DefaultCurrency) | Double | True | | No | | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## LineItems | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------------------- | -------- | -------- | ------------------------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the line item. | | Assignedto | String | False | | No | The user name of the user assigned to the record. | | AssignedUserId | String | False | [Users.Id](#users) | No | The Id of the user assigned to the record. | | CostPrice | Double | False | | No | The line item's cost price | | CostPrice(DefaultCurrency) | Double | True | | No | The line item's cost price in the system's default currency | | CreatedById | String | True | [Users.ID](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | Currency | String | False | | No | Id of the currency used for currency values | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | Description for the item | | Discount | Double | False | | No | The line item's product discount | | Discount(DefaultCurrency) | Double | True | | No | The line item's product discount in the system's default currency | | DiscountAmount | Double | False | | No | The line item's discount amount | | DiscountAmount(DefaultCurrency) | Double | True | | No | The line item's discount amount in the system's default currency | | DiscountType | String | False | | No | The type of discount for the item | | Group | String | False | | No | Group name the line item belongs to | | group_id | String | False | [LineItemGroups.Id](#lineitemgroups) | No | Group Id the line item belongs to | | ListPrice | Double | False | | No | The line item's list price | | ListPrice(DefaultCurrency) | Double | True | | No | The line item's list price in the system's default currency | | ModifiedById | String | True | [Users.ID](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Name | String | False | | No | Name assigned to the line item | | Note | String | False | | No | Description for the line item | | Number | Int | False | | No | Number assigned to the line item | | ParentID | String | False | | No | Id of the line item's parent | | Relatedto | String | False | | No | Parent name the line item is related to | | ParentType | String | False | | No | Id of the line item's parent | | PartNumber | String | False | | No | Part number assigned to the line items group | | ProductID | String | False | | No | Id assigned to the line item product | | Quantity | String | False | | No | Quantity of the line item | | Tax | String | False | | No | The line item's VAT | | TaxAmount | Double | False | | No | The line item's VAT amount | | TaxAmount(DefaultCurrency) | Double | True | | No | The line item's VAT amount in the system's default currency | | TotalPrice | Double | False | | No | The line item's total price | | TotalPrice(DefaultCurrency) | Double | True | | No | The line item's total price in the system's default currency | | UnitPrice | Double | False | | No | The line item's unit price | | UnitPrice(DefaultCurrency) | Double | True | | No | The line item's unit price in the system's default currency | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## Locations | Name | Type | ReadOnly | References | FilterOnly | Description | | -------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the location. | | Address | String | False | | No | Street address of the location | | Assignedto | String | True | | No | The user name of the user assigned to the record. | | AssignedUserId | String | False | [Users.Id](#users) | No | The Id of the user assigned to the record. | | Capacity | String | False | | No | Capacity estimated for the location | | City | String | False | | No | City of the location | | Country | String | False | | No | Country of the location | | County | String | False | | No | County of the location | | CreatedById | String | True | [Users.ID](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | Description for the location | | ModifiedById | String | True | | No | | | ModifiedByName | String | True | | No | | | Name | String | False | | No | Name assigned to the location | | Postcode | String | False | | No | Postal code of the location | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## MapAddressCache | Name | Type | ReadOnly | References | FilterOnly | Description | | -------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the address cache. | | Address | String | False | | No | Complete address of the cached address | | Assignedto | String | True | | No | The user name of the user assigned to the record. | | AssignedUserId | String | False | [Users.Id](#users) | No | The Id of the user assigned to the record. | | CreatedById | String | True | [Users.ID](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | Description for the cached address | | Latitude | Double | False | | No | Latitude coordinate of the address | | Longitude | Double | False | | No | Longitude coordinate of the address | | ModifiedById | String | True | [Users.ID](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## MapAreas | Name | Type | ReadOnly | References | FilterOnly | Description | | -------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the map area. | | User | String | True | | No | The user name of the user assigned to the record. | | AssignedUserId | String | False | [Users.Id](#users) | No | The Id of the user assigned to the record. | | City | String | False | | No | City of the map area | | Coordinates | String | False | | No | Geographical coordinates of the map area | | Country | String | False | | No | Country of the map area | | CreatedById | String | True | [Users.ID](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | Description for the map area | | ModifiedById | String | True | [Users.ID](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Name | String | False | | No | Name assigned to the line items group | | State | String | False | | No | State of the location | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## MapMarkers | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the map marker. | | User | String | True | | No | The user name of the user assigned to the record. | | AssignedUserId | String | False | [Users.Id](#users) | No | The Id of the user assigned to the record. | | City | String | False | | No | City of the map marker | | Country | String | False | | No | Country of the map marker | | CreatedById | String | True | [Users.ID](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | Description for the map marker | | Latitude | Double | False | | No | Latitude coordinate of the map marker | | Longitude | Double | False | | No | Longitude coordinate of the map marker | | MarkerImageType | String | False | | No | | | ModifiedById | String | True | [Users.ID](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Name | String | False | | No | Name assigned to the map marker | | State | String | False | | No | State of the map marker | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## Maps | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the map. | | Assignedto | String | False | | No | The user name of the user assigned to the record. | | AssignedUserId | String | False | [Users.Id](#users) | No | The Id of the user assigned to the record. | | CreatedById | String | True | [Users.ID](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | Description for the map | | Distance(Radius) | Double | False | | No | Radius being covered in the map | | ModifiedById | String | True | [Users.ID](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | ModuleTypetoDisplay | String | False | | No | Module linked to the map | | Name | String | False | | No | Name assigned to the map | | ParentID | String | False | | No | Id of the map's parent record | | ParentType | String | False | | No | Type of the map's parent | | Relatedto(Center) | String | True | | No | Name of the map's parent. Also identifies the map's center location | | UnitType | String | False | | No | Length unit expressing the radius | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## Meetings | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier for the meeting. | | AcceptLink | String | True | | No | The accept status for the meeting. | | Address | String | True | | No | Address from Google Maps of the meeting. | | Assignedto | String | False | | No | The user name of the user assigned to the record. | | AssignedUserId | String | False | [Users.Id](#users) | No | The Id of the user assigned to the record. | | Contact | String | False | | No | The name of the associated contact. | | contact_id | String | True | | No | The Id of the associated contact. | | CreatedById | String | True | [Users.Id](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The user name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | Full text of the note. | | Direction | String | True | | No | Whether the meeting is inbound or outbound. | | DisplayURL | String | False | | No | The meeting URL. | | Duration | String | True | | No | Duration handler dropdown. | | DurationHours | Int | False | | No | The duration (hours). | | DurationMinutes | Int | False | | No | The duration (minutes). | | EmailReminder | Bool | True | | No | Whether or not the email reminder value is set. | | EmailRemindersent | Bool | False | | No | Whether the email reminder is already sent. | | EmailReminderTime | String | False | | No | Specifies when a email reminder alert should be issued: -1 means no alert; otherwise the number of seconds prior to the start. | | EndDate | Datetime | False | | No | Date the meeting ends. | | ExternalAppID | String | False | | No | The meeting Id for the external app API. | | GeocodeStatus | String | True | | No | Geocode from Google Maps of the meeting. | | HostURL | String | False | | No | The host URL. | | Latitude | Double | True | | No | Latitude from Google Maps of the meeting. | | Location | String | False | | No | The location of the meeting. | | Longitude | Double | True | | No | Longitude from Google Maps of the meeting. | | MeetingCreator | String | False | | No | The meeting creator. | | MeetingPassword | String | False | | No | The password of the meeting. | | Meetingupdatesequence | Int | False | | No | Meeting update sequence for meetings as per iCalendar standards. | | ModifiedById | String | True | [Users.Id](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The user name of the user who last modified the record. | | OutlookID | String | False | | No | When the Sugar Plug-in for Microsoft Outlook syncs an Outlook appointment, this is the Outlook appointment item Id. | | ParentID | String | False | | No | Id of the first element of recurring records. | | ParentType | String | False | | No | Module the meeting is associated with. | | RecurringSource | String | False | | No | Source of recurring meeting. | | Relatedto | String | True | | No | The name of the associated parent Sugar module. | | ReminderChecked | Bool | True | | No | Whether or not the reminder value is set. | | ReminderTime | String | False | | No | Specifies when a reminder alert should be issued: -1 means no alert; otherwise the number of seconds prior to the start. | | Reminders | String | True | | No | List of reminders set for the meetings | | RepeatCount | Int | False | | No | Number of recurrences. | | RepeatDow | String | False | | No | The day of week of a meeting. | | RepeatInterval | Int | False | | No | The interval of a recurring meeting. | | RepeatParentID | String | False | | No | Id of the first element of recurring records. | | RepeatType | String | False | | No | Type of a recurring meeting. | | RepeatUntil | Date | False | | No | Repeat until the specified date. | | StartDate | Datetime | False | | No | Date of the start of the meeting. | | Start/JoinMeeting | String | False | | No | The join URL. | | Status | String | False | | No | Meeting status (e.g., Planned, Held, or Not held). | | Subject | String | False | | No | The meeting name. | | Type | String | False | | No | Meeting type (e.g., WebEx, or Other). | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## Notes | Name | Type | ReadOnly | References | FilterOnly | Description | | ---------------- | -------- | -------- | ------------------ | ---------- | --------------------------------------------------------------------------- | | ID [KEY] | String | False | | No | Unique identifier of the record. | | AccountID | String | True | | No | The Id of the account associated with the note. | | Assignedto | String | True | | No | The user name of the user assigned to the record. | | AssignedUserId | String | False | [Users.Id](#users) | No | The Id of the user assigned to the record. | | Attachment | String | False | | No | File name associated with the note (attachment). | | CaseID | String | True | | No | The Id of the case associated with the note. | | Contact | String | True | | No | The name of the contact associated with the note. | | ContactID | String | False | | No | The Id of the contact the note is associated with. | | CreatedById | String | True | [Users.Id](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The user name of the user who created the record. | | DateCreated | Datetime | True | | No | Date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | DisplayinPortal? | Bool | False | | No | Portal flag indicator, which determines if the note is created via portal. | | EmailAddress | String | True | | No | The email of the contact associated with the note. | | EmbedinEmail? | Bool | False | | No | Embed flag indicator, which determines if the note is embedded in an email. | | LeadID | String | True | | No | The Id of the lead associated with the note. | | MimeType | String | False | | No | Attachment MIME type. | | ModifiedById | String | True | [Users.Id](#users) | No | The user who last modified the record. | | ModifiedByName | String | True | | No | The user name of the user who last modified the record. | | Note | String | False | | No | Full text of the note. | | OpportunityID | String | True | | No | The Id of the opportunity associated with the note. | | ParentID | String | False | | No | The Id of the parent Sugar item. | | ParentType | String | False | | No | Sugar module the Note is associated with. | | Phone | String | True | | No | The phone number of the contact associated with the note. | | RelatedTo | String | True | | No | The name of the parent object associated with the note. | | Subject | String | False | | No | Title of the note. | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## OAuthConsumerKeys | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the OAuth key. | | User | String | True | | No | The user name of the user the key has been assigned to. | | AssignedUserId | String | False | [Users.Id](#users) | No | The Id of the user the key has been assigned to. | | ConsumerKeyName | String | False | | No | Name assigned to the key | | ConsumerKey | String | False | | No | Key value used in the OAuth 1.0 authentication with SuiteCRM | | ConsumerSecret | String | False | | No | Secret used in the OAuth 1.0 authentication with SuiteCRM | | CreatedById | String | True | [Users.ID](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | Description for the OAuth key | | ModifiedById | String | True | [Users.ID](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## OAuthTokens | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------ | ------ | -------- | ---------- | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the token. | | CallbackURL | String | False | | No | Callback URL given for the token | | Consumer | String | False | | No | Consumer key associated with the token | | ConsumerName | String | True | | No | The consumer name given for the token | | Deleted | Bool | False | | No | The record deletion indicator. | | LBL_ASSIGNED_TO_ID | String | True | | No | The user name of the user the token has been assigned to. | | AssignedUserId | String | False | | No | The Id of the user the token has been assigned to. | | Secret | String | False | | No | Consumer secret associeated with the token | | Token_TS | String | False | | No | Timestamp recorded for the token | | TState | String | False | | No | Current state of the token | | Verify | String | False | | No | Verification status of the token | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## Opportunities | Name | Type | ReadOnly | References | FilterOnly | Description | | ----------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the opportunity. | | AccountID | String | True | | No | The Id of the associated account. | | AccountName | String | True | | No | The name of the associated account. | | Address | String | True | | No | Address from Google Maps of the opprtunity. | | Amount | Double | False | | No | Formatted amount of the opportunity. | | Assignedto | String | True | | No | The user name of the user assigned to the record. | | AssignedUser | String | False | [Users.Id](#users) | No | The Id of the user assigned to the record. | | Campaign | String | True | | No | The name of the campaign that generated the lead. | | campaign_id | String | False | | No | The Id of the campaign that generated the lead. | | CreatedById | String | True | [Users.Id](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The user name of the user who created the record. | | Currency | String | False | | No | The Id of the currency used for display purposes. | | CurrencyName | String | True | | No | The name of the currency used for display purposes. | | CurrencySymbol | String | True | | No | The symbol of the currency used for display purposes. | | DateCreated | Datetime | True | | No | Date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | Full text of the note. | | ExpectedCloseDate | Date | False | | No | The expected or actual date the oppportunity will close. | | GeocodeStatus | String | True | | No | Geocode from Google Maps of the opprtunity. | | Latitude | Double | True | | No | Latitude from Google Maps of the opprtunity. | | LeadSource | String | False | | No | Source of the opportunity. | | Longitude | Double | True | | No | Longitude from Google Maps of the opprtunity. | | ModifiedById | String | True | [Users.Id](#users) | No | User who last modified the record. | | ModifiedByName | String | True | | No | The user name of the user who last modified the record. | | NextStep | String | False | | No | The next step in the sales process. | | OpportunityAmount | Double | False | | No | Unconverted amount of the opportunity. | | OpportunityName | String | False | | No | Name of the opportunity. | | Probability(%) | Int | False | | No | The probability of closure. | | SalesStage | String | False | | No | Indication of progression towards closure. | | Type | String | False | | No | Type of opportunity (e.g., Existing or New). | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## OutboundEmailAccounts | Name | Type | ReadOnly | References | FilterOnly | Description | | ----------------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the outbound account. | | Assignedto | String | True | | No | The user name of the user assigned to the record. | | AssignedUserId | String | False | [Users.Id](#users) | No | The Id of the user assigned to the record. | | ChooseyourEmailprovider | String | True | | No | identifier for the email provider | | CreatedById | String | True | [Users.ID](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | MailSendSmptType | String | False | | No | SMTP Type of the connected account | | LBL_MAIL_SENDTYPE | String | False | | No | Type of mail intended to be sent | | LBL_MAIL_SMTPSSL | String | False | | No | Secure layer protocol of the connected email account | | ModifiedById | String | True | [Users.ID](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Name | String | False | | No | Name assigned to the outbound account | | Password | String | True | | No | Password set for the account | | SendTestEmail | String | True | | No | 'Send Test Email' button content | | SMTPPassword | String | False | | No | Password to use in the SMTP authentication | | SMTPPort | Int | False | | No | Port to use in the SMTP authentication | | SMTPServer | String | False | | No | Server address to use in the SMTP authentication | | SMTPUsername | String | False | | No | Username to use in the SMTP authentication | | Type | String | False | | No | Outbound account type | | UseSMTPAuthentication? | Bool | False | | No | Whether the account to be connected will use SMTP authentication | | UserId | String | False | [Users.Id](#users) | No | Id of the user linked with the account | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## PDFTemplates | Name | Type | ReadOnly | References | FilterOnly | Description | | ---------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier for the pdf template. | | Active | Bool | False | | No | Whether or not the template is active. | | Assigned_to | String | False | | No | The assignee of the template. | | Assigned_User_Id | String | False | [Users.Id](#users) | No | The unique identifier of the assignee. | | Body | String | False | | No | Content of the template's body. | | Created_By | String | False | | No | The Id of the user who created the template. | | Created_By2 | String | False | | No | The name of the user who created the template. | | Date_Created | Datetime | False | | No | Date when the template was created. | | Date_Modified | Datetime | False | | No | Date when the template was modified. | | Deleted | Bool | False | | No | Whether the template was deleted. | | Footer | String | False | | No | The content of the template's footer. | | Header | String | False | | No | The content of the template's header. | | Insert_Fields | String | False | | No | The fields that can be inserted. | | Load_Sample | String | False | | No | The content of the template's sample. | | Margin_Bottom | Int | False | | No | Value of the bottom margin for the template. | | Margin_Footer | Int | False | | No | Value of the margin for the template's footer. | | Margin_Header | Int | False | | No | Value of the margin for the template's header. | | Margin_Left | Int | False | | No | Value of the left margin for the template. | | Margin_Right | Int | False | | No | Value of the right margin for the template. | | Margin_Top | Int | False | | No | Value of the top margin for the template. | | Modified_By | String | False | | No | The Id of the user who modified the template. | | Modified_By2 | String | False | | No | The name of the user who modified the template. | | Name | String | False | | No | The template's name. | | Orientation | String | False | | No | Orientation of the template. | | Page_Size | String | False | | No | The size of the template. | | Type | String | False | | No | The type of the template. | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## ProcessAudit | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | -------- | -------- | ------------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the inbound. | | CreatedById | String | True | [Users.ID](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | Description for the process audit | | LBL_AOW_WORKFLOW_ID | String | False | [Worflows.Id](#workflow) | No | Id of the workflow the audit is following | | Workflow | String | True | | No | Name of the workflow the audit is following | | LBL_BEAN_ID | String | False | | No | The Id of the audit's parent record | | Record | String | True | | No | Name of the audit's parent record | | ParentType | String | False | | No | Module the audit's parent belongs to | | ModifiedById | String | True | [Users.ID](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Name | String | False | | No | Name assigned to the process audit | | Status | String | False | | No | Status of the audit | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## ProductCategories | Name | Type | ReadOnly | References | FilterOnly | Description | | ---------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the inbound. | | Assignedto | String | True | | No | The user name of the user assigned to the record. | | AssignedUserId | String | False | [Users.Id](#users) | No | The Id of the user assigned to the record. | | CreatedById | String | True | [Users.ID](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | Description for the category | | Isparentcategory | Bool | False | | No | Whether this category will be a parent for other categories | | ModifiedById | String | True | [Users.ID](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Name | String | False | | No | Name assigned to the category | | ParentCategoryID | String | False | | No | Id of the category's parent category | | ParentCategory | String | True | | No | Name of the parent category | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## Products | Name | Type | ReadOnly | References | FilterOnly | Description | | ---------------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the ACL Action. | | Assignedto | String | True | | No | The user name of the user assigned to the record. | | AssignedUserId | String | False | [Users.Id](#users) | No | The Id of the user assigned to the record. | | Category | String | False | | No | Name of the product's category. | | Contact | String | True | | No | Product's point of contact name. | | contact_id | String | False | | No | Product's point of contact id. | | Cost | Double | False | | No | Cost of the product. | | Cost(DefaultCurrency) | Double | False | | No | Cost of the product in USD. | | CreatedById | String | True | [Users.Id](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | Currency | String | False | | No | The Id of the currency used for the product. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | The action description. | | ModifiedById | String | True | [Users.Id](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | PartNumber | String | False | | No | Part number of the product. | | Price | Double | False | | No | Price of the product. | | Price(DefaultCurrency) | Double | False | | No | Price of the product in USD. | | ProductCategory | String | True | | No | Name of the product's category. | | ProductCategoryID | String | False | | No | Id of the product's category. | | ProductCode | String | False | | No | The code assigned to the product | | ProductImage | String | False | | No | Image uploaded for the product. | | ProductName | String | False | | No | The action name. | | Type | String | False | | No | Type of the product. | | URL | String | False | | No | Url where the product can be seen. | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## Projects | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | Id [KEY] | String | False | | No | The unique identifier of the project. | | Address | String | True | | No | Address from Google Maps of the project. | | AssignedTo | String | False | [Users.Id](#users) | No | The user name of the user assigned to the record. | | ConsiderWorkingDays | Bool | False | | No | Whether to include business hours in the project duration. | | CreatedById | String | True | [Users.Id](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | Project description. | | EndDate | Date | False | | No | The estimated end date. | | GeocodeStatus | String | True | | No | Geocode from Google Maps of the project. | | Latitude | Double | True | | No | Latitude from Google Maps of the project. | | Longitude | Double | True | | No | Longitude from Google Maps of the project. | | ModifiedById | String | True | [Users.Id](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Name | String | False | | No | Project name. | | Priority | String | False | | No | The priority of the project. | | ProjectManager | String | True | | No | The user name of the user assigned to the project. | | ProjectTemplate | String | True | | No | Which project template was the project created from | | StartDate | Date | False | | No | The estimated start date. | | Status | String | False | | No | The status of the project. | | TotalActualEffort(hrs) | Int | True | | No | The total actual effort of the project. | | TotalEstimatedEffort(hrs) | Int | True | | No | The total estimated effort of the project. | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## ProjectTemplates | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the project template. | | TemplateName | String | False | | No | Name assigned to the template | | ProjectManager | String | True | | No | The user name of the user the template has been assigned to | | AssignedUserId | String | False | [Users.Id](#users) | No | The Id of the user the template has been assigned to. | | ConsiderWorkingDays | Bool | False | | No | Whether to include working days in the project's effort | | CreatedById | String | True | [Users.ID](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | ModifiedById | String | True | [Users.ID](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Notes | String | False | | No | Description for the project template | | Priority | String | False | | No | Priority to be assigned to the project | | Status | String | False | | No | Status to be assigned to the project | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## Quotes | Name | Type | ReadOnly | References | FilterOnly | Description | | ---------------------------- | -------- | -------- | ------------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | | | ApprovalIssues | String | False | | No | | | ApprovalStatus | String | False | | No | | | Assignedto | String | True | | No | | | AssignedUserId | String | False | | No | | | BillingCity | String | False | | No | City where the billing account is recorded in | | BillingCountry | String | False | | No | Country where the billing account is recorded in | | BillingPostal_Code | String | False | | No | Postal code of the billing account | | BillingState | String | False | | No | State where the billing account is recorded in | | BillingStreet | String | False | | No | Street where the billing account is recorded in | | billing_account_id | String | False | [Accounts.Id](#accounts) | No | Id of the billing account | | Account | String | True | | No | Billing account name for the quote | | billing_contact_id | String | False | [Contacts.Id](#contacts) | No | Id of the billing contact | | Contact | String | True | | No | Name of the billing contact | | CreatedById | String | True | [Users.ID](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | Currency | String | False | | No | Id of the currency used for currency values | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | Description for the quote | | Discount | Double | False | | No | The quote's discount amount | | Discount(DefaultCurrency) | Double | False | | No | The quote's discount amount in the system's default currency | | GrandTotal | Double | False | | No | The quote's grand total | | GrandTotal(DefaultCurrency) | Double | False | | No | The quote's grand total in the system's default currency | | InvoiceStatus | String | False | | No | Quote's invoice status | | LineItems | String | True | | No | The list of the quote's line items | | ModifiedById | String | True | [Users.ID](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Opportunity | String | True | | No | Opportunity name of the quote | | opportunity_id | String | False | | No | Opportunity Id of the quote | | PaymentTerms | String | False | | No | Selected terms for quote's payments | | QuoteNumber | Int | False | | No | The assigned quote number | | QuoteStage | String | False | | No | The quote's assigned stage | | QuoteTemplate | String | False | | No | The quote's template | | Shipping | Double | False | | No | The quote's shipping amount | | Shipping(DefaultCurrency) | Double | False | | No | The quote's shipping amount in the system's default currency | | ShippingCity | String | False | | No | City of the shipping destination | | ShippingCountry | String | False | | No | Country of the shipping destination | | ShippingPostalCode | String | False | | No | Postal code of the shipping destination | | ShippingState | String | False | | No | State of the shipping destination | | ShippingStreet | String | False | | No | Street address of the shipping destination | | ShippingTax | String | False | | No | The quote's shipping tax costs | | ShippingTax(DefaultCurrency) | Double | False | | No | The quotes's discountamount in the system's default currency | | ShippingTaxAmount | Double | False | | No | The quotes's shipping tax amount | | Subtotal | Double | False | | No | The quotes's subtotal amount | | Subtotal(DefaultCurrency) | Double | False | | No | The quotes's subtotal amount in the system's default currency | | SubtotalTax | Double | False | | No | The quotes's subtotal and tax amount | | SubtotalTaxAmount | Double | False | | No | The quotes's subtotal and tax amount in the system's default currency | | Tax | Double | False | | No | The quotes's tax amount | | Tax(DefaultCurrency) | Double | False | | No | The quotes's tax amount in the system's default currency | | Terms | String | False | | No | The quote's terms | | Title | String | False | | No | Title assigned to the quote | | Total | Double | False | | No | The quotes's total amount | | Total(DefaultCurrency) | Double | False | | No | The quotes's total amount in the system's default currency | | ValidUntil | Date | False | | No | The date the quote expires | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## Releases | Name | Type | ReadOnly | References | FilterOnly | Description | | -------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the record. | | CreatedBy | String | True | [Users.Id](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The Name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was entered. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | Whether the record is deleted. | | ModifiedById | String | True | [Users.Id](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The Name of the user who last modified the record. | | Order | Int | False | | No | The relative order in the drop-down list. | | ReleaseVersion | String | False | | No | The name of the release. | | Status | String | False | | No | The status of the record. | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## ReportCharts | Name | Type | ReadOnly | References | FilterOnly | Description | | ------------------- | -------- | -------- | ---------------------- | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the inbound. | | CreatedById | String | True | [Users.ID](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | Description for the Report Chart | | LBL_AOR_REPORT_ID | String | False | [Reports.Id](#reports) | No | The report Id of the report the chart is built on | | LBL_AOR_REPORT_NAME | String | True | | No | The report name of the report the chart is built on | | LBL_X_FIELD | Int | False | | No | Label for the X coordinate in the report | | LBL_Y_FIELD | Int | False | | No | Label for the Y coordinate in the report | | ModifiedById | String | True | [Users.ID](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Name | String | False | | No | Name assigned to the chart | | Type | String | False | | No | Type of the report chart | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## ReportConditions | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------- | -------- | -------- | ---------------------------------------- | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the inbound. | | CreatedById | String | True | [Users.ID](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | Description for the report condition | | Field | String | False | | No | Module field to select for the condition | | LBL_PARENTHESIS | String | False | [ReportConditions.Id](#reportconditions) | No | The id of the report condition to enclose in the parenthesis | | Logic | String | False | | No | The logic operator to link to the next condition | | ModifiedById | String | True | [Users.ID](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Module | String | False | | No | Which module to query in the condition | | Name | String | False | | No | Name assigned to the condition | | Operator | String | False | | No | The operator to test against the value, such as 'Equal to', 'Less than' | | Order | Int | False | | No | Defines the order in which the condition will be resolved | | Parameter | Bool | False | | No | Whether to treat the condition as a parameter | | ReportId | String | False | [Reports.Id](#reports) | No | The report Id that the condition will apply to | | Type | String | False | | No | What type of value to compare against | | Value | String | False | | No | Value to use for comparison | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## ReportFields | Name | Type | ReadOnly | References | FilterOnly | Description | | ----------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the report field entry. | | CreatedById | String | True | [Users.ID](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | Description for the report field entry | | Display | Bool | False | | No | Whether to display the selected field in the report | | Field | String | False | | No | The module field targeted for the report | | FormatOptions | String | False | | No | Additional format options | | Function | String | False | | No | Function to be applied for the field | | Group | Bool | False | | No | Whether the results from this field are grouped | | GroupOrder | String | False | | No | The order of the group by | | Label | String | True | | No | The field's label in its own module | | LBL_AOR_REPORT_ID | String | False | | No | The report Id the report field will be applied to | | LBL_GROUP_DISPLAY | Int | False | | No | Whether to display the group | | Link | Bool | False | | No | Whether to enable a link to the field | | ModifiedById | String | True | [Users.ID](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Module | String | False | | No | The module to retrieve the report field from | | Name | String | False | | No | Name assigned to the report field entry | | Order | Int | False | | No | The ordering of the report field | | Sort | String | False | | No | Sort this field by ASC or DESC | | SortOrder | String | False | | No | The ordering of the sort for the report field | | Total | String | True | | No | The function that adds the results of the report query | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## Reports | Name | Type | ReadOnly | References | FilterOnly | Description | | -------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the report. | | Assignedto | String | True | | No | The user name of the user assigned to the record. | | AssignedUserId | String | False | [Users.Id](#users) | No | The Id of the user assigned to the record. | | Chartsperrow | Int | False | | No | Number of charts to display for each row | | Conditions | String | True | | No | The complete conditions of the report | | CreatedById | String | True | [Users.ID](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | Description for the report | | DisplayFields | String | True | | No | The report fields selected for the report | | ModifiedById | String | True | [Users.ID](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Name | String | False | | No | Name assigned to the report | | ReportModule | String | False | | No | The module the report has targeted | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## Roles | Name | Type | ReadOnly | References | FilterOnly | Description | | -------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the role. | | CreatedById | String | True | [Users.Id](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The Name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was entered. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | Whether the record is deleted. | | Description | String | False | | No | The description of the role. | | ModifiedById | String | True | [Users.Id](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The Name of the user who last modified the record. | | Modules | String | False | | No | The modules the role has permission to access. | | Name | String | False | | No | The name of the role. | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## SavedSearches | Name | Type | ReadOnly | References | FilterOnly | Description | | ---------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | Id [KEY] | String | False | | No | The unique identifier of the saved search. | | AssignedUserId | String | False | [Users.Id](#users) | No | User Id assigned to the record. | | AssignedUserName | String | True | | No | The user name of the user assigned to the record. | | Contents | String | False | | No | The contents of the saved search. | | LBL_CREATED_BY | Bool | False | | No | The record deletion indicator. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Description | String | False | | No | The description of the role. | | Module | String | False | | No | The search's target module. | | Name | String | False | | No | The name of the saved search. | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## ScheduledReports | Name | Type | ReadOnly | References | FilterOnly | Description | | ----------------- | -------- | -------- | ---------------------- | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the scheduled report. | | CreatedById | String | True | [Users.ID](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | Description for the scheduled report | | EmailRecipients | String | False | | No | List of email addresses the schedule results will be sent to | | Lastrun | String | True | | No | Date of last run of the schedule | | LBL_AOR_REPORT_ID | String | False | [Reports.Id](#reports) | No | Report Id of the report that is generated | | Reports | String | True | | No | The name of the report being scheduled to run | | ModifiedById | String | True | [Users.ID](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Name | String | False | | No | Name assigned to the schedule | | Schedule | String | False | | No | The schedule expressed in cron language | | Status | String | False | | No | Status of the schedule | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## Schedulers | Name | Type | ReadOnly | References | FilterOnly | Description | | ----------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | Id [KEY] | String | False | | No | The unique identifier of the scheduler. | | ActiveFrom | String | False | | No | The time the scheduler begins to be active per day. | | ActiveTo | String | False | | No | Time the scheduler stops being active per day. | | AdvancedOptions | Bool | True | | No | Whether there are advanced options for the interval. | | CreatedById | String | True | [Users.Id](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | DateTimeEnd | Datetime | False | | No | The end date and time. | | DateTimeStart | Datetime | False | | No | The start date and time. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | ExecuteIfMissed | Bool | False | | No | Whether the scheduler will catch up. | | Interval | String | False | | No | The job interval expressed in standard crontab notation | | Job | String | False | | No | The job. | | JobFunction | String | True | | No | The job function. | | JobName | String | False | | No | The name of the scheduler. | | JobURL | String | True | | No | The job URL. | | LastSuccessfulRun | Datetime | False | | No | The last run time of the scheduler. | | ModifiedById | String | True | [Users.Id](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Status | String | False | | No | The status of the scheduler. | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## SecurityGroupsManagement | Name | Type | ReadOnly | References | FilterOnly | Description | | -------------------------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the security group. | | Assignedto | String | True | | No | The user name of the user assigned to the record. | | AssignedUserId | String | False | [Users.Id](#users) | No | The Id of the user assigned to the record. | | CreatedById | String | True | [Users.ID](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | Description for the security group | | LBL_SECURITYGROUP_NONINHERITABLE | Bool | True | | No | Whether the group is inheritable | | LBL_securitygroup_noninherit_id | String | True | | No | Non-Inheritance Id | | ModifiedById | String | True | [Users.ID](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Name | String | False | | No | | | NotInheritable | Bool | False | | No | Whether the group is inheritable | | PrimaryGroup | Bool | True | | No | Whether the group is primary | | UserName | String | True | | No | User fields for the group | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## Spots | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the record. | | Assignedto | String | True | | No | The user name of the user assigned to the record. | | AssignedUser_Id | String | False | [Users.Id](#users) | No | The Id of the user assigned to the record. | | Config | String | False | | No | The the configuration set of the spot. | | Configuration | String | True | | No | The GUI settings of the spot. | | CreatedById | String | True | [Users.Id](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | Full text of the note. | | ModifiedById | String | True | [Users.Id](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Name | String | False | | No | The name of the spot. | | Type | String | False | | No | The field this spot is targeting. | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## SuiteCRMFeed | Name | Type | ReadOnly | References | FilterOnly | Description | | -------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the feed entry. | | Assignedto | String | True | | No | The user name of the user assigned to the record. | | AssignedUserId | String | False | [Users.Id](#users) | No | The Id of the user assigned to the record. | | CreatedById | String | True | [Users.ID](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | Description for the feed entry | | LinkType | String | False | | No | Type of link to the feed | | LinkUrl | String | False | | No | The URL to the feed | | ModifiedById | String | True | [Users.ID](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Name | String | False | | No | A summary of the feed | | RelatedId | String | False | | No | The record Id related to the feed | | RelatedModule | String | False | | No | The module returned by the feed | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## TargetLists | Name | Type | ReadOnly | References | FilterOnly | Description | | -------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The Id of the target list. | | Assignedto | String | True | | No | The user name of the user assigned to the record. | | AssignedUserId | String | False | [Users.Id](#users) | No | The Id of the user assigned to the record. | | CreatedBy | Bool | False | | No | The record deletion indicator. | | CreatedById | String | True | [Users.Id](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Description | String | False | | No | The description of the target list. | | DomainName | String | False | | No | The domain name of the target list. | | MarketingId | String | True | | No | The marketing Id of the target list. | | MarketingName | String | True | | No | The marketing name of the target list. | | ModifiedById | String | True | [Users.Id](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Name | String | False | | No | The name of the target list. | | TargetsinList | Int | True | | No | The entry count of the prospect list. | | Type | String | False | | No | The type of the target list. | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## Targets | Name | Type | ReadOnly | References | FilterOnly | Description | | ---------------------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the record. | | AccountName | String | False | | No | The name of the associated acocunt. | | Address | String | True | | No | Address from Google Maps of the target. | | AlternateAddressCity | String | False | | No | The city for the alternate address. | | AlternateAddressCountry | String | False | | No | The country for the alternate address. | | AlternateAddressPostalCode | String | False | | No | The postal code for the alternate address. | | AlternateAddressState | String | False | | No | The state for the alternate address. | | AlternateAddressStreet | String | False | | No | The street address for the alternate address. | | AlternateAddressStreet2 | String | True | | No | The second line of the alternate address. | | AlternateAddressStreet3 | String | True | | No | The third line of the alternate address. | | AnyEmail | String | True | | No | The email for the target. | | AssignedUserId | String | False | [Users.Id](#users) | No | The Id of the user assigned to the record. | | AssignedUserName | String | True | | No | The user name of the user assigned to the record. | | Assistant | String | False | | No | The name of the assistant of the target. | | AssistantPhone | String | False | | No | The phone number of the assistant of the target. | | Birthdate | Date | False | | No | The birthdate of the target. | | CampaignID | String | False | | No | Campaign that generated the lead. | | CreatedById | String | True | [Users.Id](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Department | String | False | | No | The department of the target. | | Description | String | False | | No | Full text of the note. | | DoNotCall | Bool | False | | No | An indicator of whether the target can be called. | | EmailAddress | String | False | | No | The alternate email for the target. | | EmailOptOut | Bool | True | | No | Whether the target has opted out of radio. | | Fax | String | False | | No | The target fax number. | | FirstName | String | False | | No | The first name of the target. | | FullName | String | True | | No | The full name of the target. | | GeocodeStatus | String | True | | No | Geocode from Google Maps of the target. | | Home | String | False | | No | Home phone number of the target. | | InvalidEmail | Bool | True | | No | Whether the target email has been marked as invalid. | | LastName | String | False | | No | The last name of the target. | | Latitude | Double | True | | No | Latitude from Google Maps of the target. | | LBL_CONT_ACCEPT_STATUS | String | True | | No | The event accept status fields. | | LBL_CONT_INVITE_STATUS | String | True | | No | The event invite status fields. | | LBL_LIST_ACCEPT_STATUS | String | True | | No | Id of the target's event status. | | LBL_LIST_ACCEPT_STATUS_EVENT | String | True | | No | Status of the target's event accept. | | LBL_LIST_INVITE_STATUS | String | True | | No | Id of the target's event invite. | | LBL_LIST_INVITE_STATUS_EVENT | String | True | | No | Name of the target's event status. | | LeadId | String | False | | No | The Id of the associated lead. | | Longitude | Double | True | | No | Longitude from Google Maps of the target. | | Mobile | String | False | | No | Mobile phone number of the target. | | ModifiedById | String | True | [Users.Id](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Name | String | True | | No | The name of the target. | | NonPrimaryE-mails | String | True | | No | The nonprimary email addresses for the target. | | OfficePhone | String | False | | No | Work phone number of the target. | | OtherEmail | String | True | | No | The alternate email for the target. | | OtherPhone | String | False | | No | Other phone number for the target. | | Photo | String | False | | No | The picture for the target. | | PrimaryAddressCity | String | False | | No | The city for the primary address. | | PrimaryAddressCountry | String | False | | No | The country for the primary address. | | PrimaryAddressPostalCode | String | False | | No | The postal code for the primary address. | | PrimaryAddressState | String | False | | No | The state for the primary address. | | PrimaryAddressStreet | String | False | | No | The street address used for the primary address. | | PrimaryAddressStreet2 | String | True | | No | The second line of the primary address. | | PrimaryAddressStreet3 | String | True | | No | The third line of the primary addrss. | | Salutation | String | False | | No | The target salutation (e.g., Mr. or Ms.). | | Title | String | False | | No | The title of the target. | | TrackerKey | Int | False | | No | The key for the associated tracker. | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## Tasks | Name | Type | ReadOnly | References | FilterOnly | Description | | -------------- | -------- | -------- | ------------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the record. | | Assignedto | String | True | | No | The name of the user assigned to the record. | | AssignedUserId | String | False | [Users.Id](#users) | No | The Id of the user assigned to the record. | | ContactID | String | False | [Contacts.Id](#contacts) | No | The Id of the associated contact. | | ContactName | String | True | | No | The name of the associated contact. | | ContactPhone | String | True | | No | The phone of the associated contact. | | CreatedById | String | True | [Users.Id](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | The full text of the note. | | DueDate | Datetime | False | | No | The due date of the task. | | DueTime | Datetime | True | | No | The time the task is due. | | EmailAddress | String | True | | No | The email of the associated contact. | | ModifiedById | String | True | [Users.Id](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | NoDueDate | Bool | False | | No | Whether the task has a due date. | | NoStartDate | Bool | False | | No | Whether the flag has a start date. | | ParentID | String | False | | No | The Id of the Sugar item to which the call is related. | | ParentType | String | False | | No | The type of the Sugar item to which the call is related. | | Priority | String | False | | No | The priority of the task. | | Relatedto | String | True | | No | The name of the Sugar item to which the call is related. | | StartDate | Datetime | False | | No | The start date of the task. | | Status | String | False | | No | The status of the task. | | Subject | String | False | | No | The name of the task. | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## TemplateSectionLine | Name | Type | ReadOnly | References | FilterOnly | Description | | -------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the template section line. | | CreatedById | String | True | | No | The user name of the user assigned to the record. | | CreatedByName | String | True | | No | | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | Complete HTML text for the line | | Group | String | False | | No | The group assigned to the line | | ModifiedById | String | True | [Users.ID](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Name | String | False | | No | Name assigned to the template section line | | Order | Int | False | | No | The line order of the section compared to the other lines in the group | | Thumbnail | String | False | | No | Image url | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## Trackers | Name | Type | ReadOnly | References | FilterOnly | Description | | ---------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | Int | False | | No | The unique identifier of the tracker. | | Action | String | False | | No | The type of action being tracked | | DateofLastAction | Datetime | True | | No | Date when the action last took place | | Deleted | Bool | False | | No | The record deletion indicator. | | ItemId | String | True | | No | Id of the record being tracked | | ItemSummary | String | True | | No | Name of the record being tracked | | MonitorId | String | True | | No | Id of the tracker monitor | | RecordVisible | Bool | True | | No | Whether the record is visible | | SessionId | String | True | | No | Which session Id made the change | | Trackers | String | False | | No | The module being tracked | | UserId | String | True | [Users.Id](#users) | No | User Id that made the change | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## Users | Name | Type | ReadOnly | References | FilterOnly | Description | | -------------------------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the user. | | AcceptStatusC | String | False | | No | The fields for the accept status of the call. | | AcceptStatusId | String | False | | No | The Id of the accept status. | | AcceptStatusM | String | False | | No | The fields for the accept status of the meeting. | | AcceptStatusName | String | False | | No | The name of the accept status. | | AddressCity | String | False | | No | The city in the address. | | AddressCountry | String | False | | No | The country in the address. | | AddressPostalCode | String | False | | No | The ZIP code in the address. | | AddressState | String | False | | No | The state in the address. | | AddressStreet | String | False | | No | The street address of the user. | | AssignedTo | String | False | [Users.Id](#users) | No | The Id of the user who created the record. | | AuthenticationId | String | False | | No | The authentication Id. | | CreatedByName | String | True | | No | The name of the user who created the record. | | DateEntered | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Department | String | False | | No | The department of the user. | | Description | String | False | | No | The description for the user. | | DisplayEmployeeRecord | Bool | False | | No | Whether the user is shown on the employees tab. | | EmailAddress | String | False | | No | The alternate email address of the user. | | EmailClient | String | False | | No | The link type of the email. | | EmployeeStatus | String | False | | No | The status of the employee. | | ExternalAuthentication | Bool | False | | No | Whether only external authentication is enabled for the user. | | Fax | String | False | | No | The fax of the user. | | FirstName | String | False | | No | The first name of the user. | | FullName | String | False | | No | The full name of the user. | | GroupUser | Bool | False | | No | Whether the user is a group. | | HomePhone | String | False | | No | The home phone number of the user. | | IMName | String | False | | No | The Id of the messenger. | | IMType | String | False | | No | The type of the messenger. | | IsAdministrator | Bool | False | | No | Whether the user is an admin. | | IsSuiteCRMUser | Bool | False | | No | Whether the user is SuiteCRM user. If not, it is a guest user. | | LastName | String | False | | No | The last name of the user. | | LBL_SECURITYGROUP_NONINHERITABLE | Bool | False | | No | Whether the group is non inheritable. | | LBL_securitygroup_noninherit_id | String | False | | No | The security group's non-inheritance id. | | Mobile | String | False | | No | The mobile phone number of the user. | | ModifiedById | String | True | [Users.Id](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Name | String | False | | No | Full name for the user | | NotifyonAssignment | Bool | False | | No | Whether the user can receive notifications. | | OtherPhone | String | False | | No | The alternate phone number of the user. | | Password | String | False | | No | The hashed password for the user. | | PasswordLastChanged | Datetime | False | | No | The date and time the password was last changed. | | Photo | String | False | | No | The photo for the user. | | PortalAPIUser | Bool | False | | No | Whether the user is portal only. | | PrimaryGroup | Bool | False | | No | The primary security group the user is assigned to. | | Reportsto | String | False | | No | The name of the manager of the user. | | ReportstoID | String | False | | No | The Id of the manager of the user. | | SecurityGroup | String | False | | No | The security group's fields that are selected for non-inheritance. | | Status | String | False | | No | The status of the user. | | SystemGeneratedPassword | Bool | False | | No | Whether the user has a system-generated password. | | Title | String | False | | No | The title of the user. | | UserType | String | False | | No | The type of the user. | | Username | String | False | | No | The user name of the user. | | WorkPhone | String | False | | No | The work phone number of the user. | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## WorkFlow | Name | Type | ReadOnly | References | FilterOnly | Description | | -------------- | -------- | -------- | ------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the inbound. | | Actions | String | True | | No | The list of actions to be taken in the workflow | | Assignedto | String | True | | No | The user name of the user assigned to the record. | | AssignedUserId | String | False | [Users.Id](#users) | No | The Id of the user assigned to the record. | | CreatedById | String | True | [Users.Id](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | Conditions | String | True | | No | The list of conditions to be applied during the workflow | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | Description for the worflow | | LBL_RUN_ON | String | False | | No | Which records the workflow will operate on | | ModifiedById | String | True | [Users.Id](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Name | String | False | | No | Name assigned to the workflow | | RepeatedRuns | Bool | False | | No | Whether the worflow will run once or several times | | Run | String | False | | No | On which occasion the workflow will execute | | Status | String | False | | No | The status of the workflow | | WorkflowModule | String | False | | No | The module the workflow will target | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## WorkFlowActions | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------- | -------- | -------- | ------------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the workflow. | | Action | String | False | | No | The Specific action to be taken during the worklow | | CreatedById | String | True | [Users.Id](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | Description for the workflow | | LBL_ORDER | Int | False | | No | The order of the worflow's action | | LBL_WORKFLOW_ID | String | False | [Workflow.Id](#workflow) | No | The wokflow the action is linked to | | ModifiedById | String | True | [Users.Id](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Name | String | False | | No | Name assigned to the action | | Parameters | String | False | | No | List of parameters for the action | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported) ## WorkFlowConditions | Name | Type | ReadOnly | References | FilterOnly | Description | | --------------- | -------- | -------- | ------------------------ | ---------- | ------------------------------------------------------------------------ | | ID [KEY] | String | False | | No | The unique identifier of the inbound. | | CreatedById | String | True | [Users.Id](#users) | No | The Id of the user who created the record. | | CreatedByName | String | True | | No | The name of the user who created the record. | | DateCreated | Datetime | True | | No | The date the record was created. | | DateModified | Datetime | True | | No | The date the record was last modified. | | Deleted | Bool | False | | No | The record deletion indicator. | | Description | String | False | | No | Description for the workflow condition | | Field | String | False | | No | The module field selected for the condition | | ModifiedById | String | True | [Users.Id](#users) | No | The Id of the user who last modified the record. | | ModifiedByName | String | True | | No | The name of the user who last modified the record. | | Module | String | False | | No | The module selected to apply the condition | | Name | String | False | | No | Name assigned to the workflow condition | | Operator | String | False | | No | Operator to test against | | LBL_ORDER | Int | False | | No | The condition's order in the workflow | | LBL_WORKFLOW_ID | String | False | [Workflow.Id](#workflow) | No | The workflow the condition will be applied for | | Type | String | False | | No | Type of the field | | Value | String | False | | No | The value to compare against the field | | Rows@Next | String | False | | Yes | Identifier for the next page of results. Do not set this value manually. | [Return to Top](#objects-supported)