The CData Sync App provides a straightforward way to continuously pipeline your Act! CRM data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The Act! CRM connector can be used from the CData Sync application to pull data from Act! CRM and move it to any of the supported destinations.
The Sync App leverages the Act! Web API for bidirectional access to Act! CRM data from Act! Premium on-premises and Act! Premium Cloud. The Sync App also supports Act! Premium for Desktop, but you need an active subscription to connect.
For required properties, see the Settings tab.
For connection properties that are not typically required, see the Advanced tab.
You can connect to either Act! CRM or Act! Premium Cloud. Set the following to connect:
This section details a selection of advanced features of the Act! CRM Sync App.
The Sync App supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .
Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .
Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
For further information, see Query Processing.
By default, the Sync App attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.
To specify another certificate, see the SSLServerCert connection property.
To authenticate to an HTTP proxy, set the following:
Set the following properties:
CData Sync App models entities in the Act! CRM Premium APIs as relational Views. The Sync App leverages the Act! Web API for bidirectional access to Act! CRM data from Act! Premium on-premises and Act! Premium Cloud. The Sync App also supports Act! Premium for Desktop, but you need an active subscription to connect.
The views are defined in schema files, .rsd files with a simple format that makes them easy to edit. Set the Location property to the path to the folder containing the .rsd files.
The Sync App models the data in Act! CRM as a list of tables in a relational database that can be queried using standard SQL statements.
| Name | Description |
| Activities | Create, update, delete and query the Activities in your Act! CRM database. |
| Companies | Create, update, delete and query the Companies created in your Act! CRM database. |
| CompanyContacts | Query the Contacts belonging to a Company. |
| ContactNotes | Query and delete the Notes for a given Act! CRM Contact. |
| Contacts | Create, update, delete and query the Contacts in your Act! CRM database. |
| GroupContacts | Query and delete the Contacts belonging to a Group. |
| Groups | Create, update, delete and query the Groups participating in your Act! CRM database. |
| Histories | Get, Create, Update or Delete all history items. |
| Notes | Create, update, delete and query the Notes in your Act! CRM database. |
| Opportunities | Create, update, delete and query the Opportunities in your Act! CRM database. |
| OpportunityCompanies | Query and delete the Companies related to an Act! CRM opportunity. |
| OpportunityContacts | Query and delete the Contacts associated with an Opportunity. |
| OpportunityGroups | Query and delete the Act! CRM Groups associated with an Opportunity. |
| OpportunityProducts | Update, delete and query the Products associated with an Opportunity. |
| Products | Create, update, delete and query the Products in your Act! CRM database. |
Create, update, delete and query the Activities in your Act! CRM database.
SELECT * FROM Activities WHERE Location = 'London' SELECT * FROM Activities WHERE Subject = 'Team meeting'
To insert a activity, you must specify atleast one contact, start time and end time.
INSERT INTO Activities (ContactsAggregate, StartTime, EndTime) VALUES ('123456', '2020-01-27 10:00:000', '2020-01-31 10:00:00')
Any column where ReadOnly=False can be updated. Specify the Activity Id when updating a group
UPDATE Activities SET ActivityPriorityId = 1, isPrivate = false WHERE Id = '12345'
Activities can be deleted by providing an Id and issuing a DELETE statement.
DELETE FROM Activities WHERE Id = '12345'
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
A unique identifier that represents the activity. |
| ActivityPriorityId | Integer | False |
Activity Priority value |
| ActivityPriorityName | String | False |
Displays the priority of the activity. |
| ActivityTypeId | Integer | True |
Displays the id of the type of the activity. |
| ActivityTypeName | String | True |
Displays the type of the activity. |
| AttachmentDisplayName | String | False |
Gets presentation name of the attachment. |
| AttachmentFileExtension | String | False |
Gets the extension of the Attachment |
| AttachmentFileName | String | False |
Gets a string representing the directory's full path. |
| AttachmentFileSize | Int | False |
Gets the size (bytes) of the attachments. |
| AttachmentFileSizeDisplay | String | False |
Gets the displayable text representation of the attachment |
| AttachmentFileType | String | False |
Gets the registered system file type name of the attachment |
| AttachmentLastModified | Datetime | False |
Gets the last modified date of the attachment |
| AttachmentPersonal | Bool | False |
Indicates whether the attachment is bound for the personal supplemental files or the workgroup supplemental files. |
| CompaniesAggregate | String | False |
List of companies that are associated to this activity. |
| ContactsAggregate | String | False |
List of contacts that are associated to this activity. |
| Created | Datetime | True |
The date and time the activity was created. |
| Details | String | False |
Additional detailed information about the activity. |
| Edited | Datetime | True |
The date and time the activity was last updated. |
| EndTime | Datetime | False |
The time the activity is to end |
| GroupsAggregate | String | False |
List a groups that are associated to this activity. |
| IsCleared | Bool | False |
Indicates that the activity has been cleared. |
| IsPrivate | Bool | False |
Indicates elevated security that only the creator/owner has access to this activity. |
| IsTimeless | Bool | False |
Indicates whether a specifies action is to be completed at a specific time-of-day. |
| Location | String | False |
Describes the physical location that the activity is to take place. |
| OpportunitiesAggregate | String | False |
List a opportunities that are associated to this activity. |
| RecurSpecDayDayAsInt | Int | False |
An integer representation of the day of the week portion of a recurrence pattern. |
| RecurSpecDayDaysOfWeek | String | False |
Representation of the day of the week portion of a recurrence pattern. |
| RecurSpecDayDayType | String | False |
Describing the day-portion of the recurrence pattern. |
| RecurSpecDayOrdinal | String | False |
Describes recurrence in relative terms for certain recurrence patterns (i.e. First, Third, Last) . |
| RecurSpecDayTypedDay | String | False |
Describing the TypedDay (Day, WeekDay or Weekend Day) for the recurrence pattern when DayType is |
| RecurSpecFrequency | Int | False |
Represents how often for the recurrence patterns |
| RecurSpecIsEndless | Bool | False |
Flag denoting whether an end date has been specified for the pattern. Note: If false, the following defaults are used: For Daily and Weekly: 2 years beyond the start date For Monthly and Yearly: June 6, 2073. |
| RecurSpecMonth | Int | False |
Represents the specific month for certain recurrence patterns |
| RecurSpecRecurType | String | False |
Represents a unit of time used to separate recurences (i.e. Daily, Weekly, Monthly, Yearly). |
| RecurSpecSeriesEnd | Datetime | False |
Specifiying the ending time for a given day. |
| RecurSpecSeriesStart | Datetime | False |
Specifiying the starting time for a given day. |
| ScheduledBy | String | True |
The contact who created this activity. |
| ScheduledFor | String | False |
The name of the activity's organizer. |
| SeriesID | String | True |
A unique identifier that represents the activity. The id that is returned is based on if it is a recurring or not. Recurrent activity: RecurSourceActivityId or Single Occurence activity: ActivityID |
| StartTime | Datetime | False |
The time the activity is to begin |
| Subject | String | False |
A description of the action to be completed. |
| IsAlarmCleared | Bool | False |
Boolean value of IsAlarmCleared. |
| IsAlarmed | Bool | False |
Boolean value of IsAlarmed. |
| LeadMinutes | Int | False |
Lead minutes. |
| AlarmDue | String | False |
Alarm due. |
| ExternalId | String | False |
External Id. |
| AccessorId | String | False |
Accessor Id. |
| ScheduledById | String | False |
Scheduled Id. |
| ScheduledForId | String | False |
Scheduled for Id. |
Create, update, delete and query the Companies created in your Act! CRM database.
The Sync App uses the Act! CRM API to process search criteria that refer to the supported fields.
The Sync App processes other filters client-side within the Sync App. For example, the following queries are
processed server side:
SELECT * FROM Companies WHERE Id = '12345' SELECT * FROM Companies WHERE Name = 'TSS company'
To insert a company, you need to specify the Company Name
INSERT INTO Companies (Name) VALUES ('New Company')
Any column where ReadOnly=False can be updated. Specify the Company Id when updating a group
UPDATE Companies SET AddressCity = 'Bangalore', AddressCountry = 'India' WHERE Id = '12345'
Companies can be deleted by providing an Id and issuing a DELETE statement.
DELETE FROM Companies WHERE Id = '12345'
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
The unique identifier (id) for this company. |
| Created | Datetime | True |
Created date of the company. |
| Name | String | False |
The company's given name. |
| AddressCity | String | False |
An inhabited place of greater size, population, or importance than a town or village. |
| AddressCountry | String | False |
A nation with its own government, occupying a particular territory. |
| AddressLine1 | String | False |
Primary street address |
| AddressLine2 | String | False |
Secondary street address |
| AddressLine3 | String | False |
Miscellaneous street address |
| AddressPostalCode | String | False |
A code of letters and digits added to a postal address to aid in the sorting of mail. |
| AddressState | String | False |
A nation or territory considered as an organized political community under one government. |
| BillingAddressCity | String | False |
An inhabited place of greater size, population, or importance than a town or village. |
| BillingAddressCountry | String | False |
A nation with its own government, occupying a particular territory. |
| BillingAddressLine1 | String | False |
Primary street address |
| BillingAddressLine2 | String | False |
Secondary street address |
| BillingAddressLine3 | String | False |
Miscellaneous street address |
| BillingAddressPostalCode | String | False |
A code of letters and digits added to a postal address to aid in the sorting of mail. |
| BillingAddressState | String | False |
A nation or territory considered as an organized political community under one government. |
| Description | String | False |
A brief written representation or account of this company. |
| Division | String | False |
The name of a smaller part of a parent company tasked with overseeing different types of products or services than those offered by the parent company. |
| Edited | Datetime | True |
Edited data of the company. |
| EditedBy | String | True |
User who edited the company record. |
| Fax | String | False |
The company's fax phone number. |
| FaxExtension | String | False |
The company's fax phone number extension. |
| HierarchyLevel | Int | False |
The positional level of where this company lays within a company hierarchy. |
| IdStatus | String | False |
The relative social or professional position of an individual within a group or organization. |
| Industry | String | False |
Economic activity concerned with the processing of raw materials and manufacture of goods in factories. |
| NumberOfEmployees | Int | False |
The total number of employees that this company operates with. |
| ParentID | String | True |
The unique identifier (id) of the parent company. |
| Phone | String | False |
The company's phone number. |
| PhoneExtension | String | False |
The company's phone number extension. |
| RecordOwner | String | True |
Owner of the company record. |
| ReferredBy | String | False |
Mention or allude to. |
| Region | String | False |
A part of a country, of the world, etc., that is different or separate from other parts in some way. |
| Revenue | Decimal | False |
The amount of money that this company actually receives during a specific period, including discounts and deductions for returned merchandise. |
| ShippingAddressCity | String | False |
An inhabited place of greater size, population, or importance than a town or village. |
| ShippingAddressCountry | String | False |
A nation with its own government, occupying a particular territory. |
| ShippingAddressLine1 | String | False |
Primary street address |
| ShippingAddressLine2 | String | False |
Secondary street address |
| ShippingAddressLine3 | String | False |
Miscellaneous street address |
| ShippingAddressPostalCode | String | False |
A code of letters and digits added to a postal address to aid in the sorting of mail. |
| ShippingAddressState | String | False |
A nation or territory considered as an organized political community under one government. |
| SicCode | String | False |
Standard Industrial Classification (SIC) codes are four-digit numerical codes assigned by the U.S. government to business establishments to identify the primary business of the establishment. |
| Territory | String | False |
Geographical area. |
| TickerSymbol | String | False |
An arrangement of characters (usually letters) representing a particular security listed on an exchange or otherwise traded publicly. |
| TollFreeExtension | String | False |
The company's toll free phone number. |
| TollFreePhone | String | False |
The company's toll free phone number. |
| Website | String | False |
The company's website. |
| AddressLatitude | Decimal | False |
The angular distance of a place north or south of the earth's equator, or of a celestial object north or south of the celestial equator, usually expressed in degrees and minutes. |
| AddressLongitude | Decimal | False |
The angular distance of a place east or west of the meridian at Greenwich, England, or west of the standard meridian of a celestial object, usually expressed in degrees and minutes. |
| BillingAddressLatitude | Decimal | False |
The Billing address latitude. |
| BillingAddressLongitude | Decimal | False |
The Billing address longitude. |
| ShippingAddressLatitude | Decimal | False |
The Shipping address latitude. |
| ShippingAddressLongitude | Decimal | False |
The Shipping address longitude. |
| HasDivisions | Boolean | False |
This readonly property indicates that this company has divisions. |
| ImportDate | Datetime | False |
This readonly property displays the date that the opportunity was imported into the system. |
| IsPrivate | Boolean | False |
Indicates elevated security that only the creator/owner has access to this company. |
| RootParentId | String | False |
The unique identifier (id) of the parent company. |
| RecordManagerID | String | False |
The record manager. |
| CustomFields | String | False |
Custom fields. |
| RecordManager | String | False |
Manager of the activity. |
Query the Contacts belonging to a Company.
SELECT * FROM CompanyContacts WHERE Fullname = 'Contact name'
CompanyContacts can be deleted by providing CompanyId and Id and issuing a DELETE statement.
DELETE FROM CompanyContacts WHERE CompanyId = '12345' AND Id = '56789'
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique identifier (id) for this contact. |
| CompanyId [KEY] | String | False |
The unique identifier (id) of the company to retrieve contacts from. |
| Created | Datetime | False |
Created data of the contact. |
| FullName | String | False |
The first name, any middle names, and surname of a contact. This may also include name prefixes and sufixes that are defined within Act! |
| AltEmailAddress | String | False |
A unique electronic address that an individual can be contacted. |
| AlternateExtension | String | False |
The contact's alternate phone number extension. |
| AlternatePhone | String | False |
The contact's alternate phone number. |
| Birthday | Datetime | False |
The anniversary of the day on which a person was born. |
| BusinessAddressCity | String | False |
An inhabited place of greater size, population, or importance than a town or village. |
| BusinessAddressCountry | String | False |
A nation with its own government, occupying a particular territory. |
| BusinessAddressLine1 | String | False |
Primary street address |
| BusinessAddressLine2 | String | False |
Secondary street address |
| BusinessAddressLine3 | String | False |
Miscellaneous street address |
| BusinessAddressPostalCode | String | False |
A code of letters and digits added to a postal address to aid in the sorting of mail. |
| BusinessAddressState | String | False |
A nation or territory considered as an organized political community under one government. |
| BusinessExtension | String | False |
The contact's business phone number extension. |
| BusinessPhone | String | False |
The contact's business phone number. |
| Company | String | False |
The organization that this contact is associated with. |
| ContactType | String | False |
The type of contact: Contact, Secondary, or User. |
| Department | String | False |
An area of special expertise or responsibility. |
| Edited | Datetime | False |
Edited date of the contact. |
| EditedBy | String | False |
User who edited the contact. |
| EmailAddress | String | False |
A unique electronic address that an individual can be contacted. |
| FaxExtension | String | False |
The contact's fax phone number extension. |
| FaxPhone | String | False |
The contact's fax phone number. |
| FirstName | String | False |
A personal given name. |
| HomeAddressCity | String | False |
An inhabited place of greater size, population, or importance than a town or village. |
| HomeAddressCountry | String | False |
A nation with its own government, occupying a particular territory. |
| HomeAddressLine1 | String | False |
Primary street address |
| HomeAddressLine2 | String | False |
Secondary street address |
| HomeAddressLine3 | String | False |
Miscellaneous street address |
| HomeAddressPostalCode | String | False |
A code of letters and digits added to a postal address to aid in the sorting of mail. |
| HomeAddressState | String | False |
A nation or territory considered as an organized political community under one government. |
| HomeExtension | String | False |
The contact's home phone extension. |
| HomePhone | String | False |
The contact's home phone number. |
| IdStatus | String | False |
The relative social or professional position of an individual within a group or organization. |
| IsUser | Bool | False |
An indicator if this contact is also a user within the system. |
| JobTitle | String | False |
The title or position this contact holds. |
| LastName | String | False |
The family name or surname. |
| LastResults | String | False |
Identifies last communication or action with a contact. |
| Latitude | Decimal | False |
The angular distance of a place north or south of the earth's equator, or of a celestial object north or south of the celestial equator, usually expressed in degrees and minutes. |
| Longitude | Decimal | False |
The angular distance of a place east or west of the meridian at Greenwich, England, or west of the standard meridian of a celestial object, usually expressed in degrees and minutes. |
| MessengerID | String | False |
An online identifier alias. |
| MiddleName | String | False |
A name between one's first name and surname. |
| MobileExtension | String | False |
The contact's mobile phone extension. |
| MobilePhone | String | False |
The contact's mobile phone number. |
| NamePrefix | String | False |
A patronymic prefix. |
| NameSuffix | String | False |
Provides additional information about the person that identifies an individual position, educational degree, accreditation, orffice, or honors. |
| PagerExtension | String | False |
The contact's pager phone number extension |
| PagerPhone | String | False |
The contact's pager phone number. |
| PersonalEmailAddress | String | False |
A unique electronic address that an individual can be contacted. |
| RecordOwner | String | False |
Owner user of the record. |
| ReferredBy | String | False |
Indiciates how this contact came about. |
| Salutation | String | False |
A gesture or utterance made as a greeting or acknowledgment. |
| Website | String | False |
The contact's web site. |
| IsFavorite | Bool | False |
Assign this contact as a favorite. |
| IsImported | Bool | False |
Identifies last communication or action with a contact. |
| ImportDate | Datetime | False |
This readonly property displays the date that the opportunity was imported into the system. |
| IsPrivate | Bool | False |
Identifies last communication or action with a contact. |
| LastEmail | String | False |
The last email. |
| LastAttempt | String | False |
The last attempt. |
| LastReach | String | False |
The last reach. |
| LastMeeting | String | False |
The last meeting. |
| LastLetterSent | String | False |
The last letter sent. |
| AmaScore | Int | False |
The contact's. |
| BusinessAddressLatitude | Decimal | False |
The business address latitude. |
| BusinessAddressLongitude | Decimal | False |
The business address longitude. |
| BusinessCountryCode | Int | False |
The contact's business phone country code. |
| BusinessMaskFormat | String | False |
The contact's business phone mask format. |
| MobileCountryCode | Int | False |
The contact's mobile phone country code. |
| MobileMaskFormat | String | False |
The contact's mobile phone mask format. |
| FaxCountryCode | Int | False |
The contact's fax phone country code. |
| FaxMaskFormat | String | False |
The contact's fax phone mask format. |
| HomeAddressLatitude | Decimal | False |
The Home address latitude. |
| HomeAddressLongitude | Decimal | False |
The Home address longitude. |
| HomeCountryCode | Int | False |
The contact's home phone country code. |
| HomeMaskFormat | String | False |
The contact's home phone mask format. |
| AlternateCountryCode | Int | False |
The contact's alternate phone country code. |
| AlternateMaskFormat | String | False |
The contact's alternate phone mask format. |
| PagerCountryCode | Int | False |
The contact's pager phone country code. |
| PagerMaskFormat | String | False |
The contact's pager phone mask format. |
| AemOptOut | Boolean | False |
AemOptOut. |
| AemBounceBack | Boolean | False |
AemBounceBack. |
| RecordManagerID | String | False |
The record manager. |
| QuickbooksId | String | False |
Quickbooks external Id to match record with quickbooks contact. |
| NylasContactId | String | False |
Nylas contact Id to match record with a contact. |
| CustomFields | String | False |
Custom fields. |
| RecordManager | String | False |
Manager of the activity. |
Query and delete the Notes for a given Act! CRM Contact.
SELECT * FROM ContactNotes WHERE ContactId = '12345'
ContactNotes can be deleted by providing ContactId and Id (Note Id) and issuing a DELETE statement.
DELETE FROM ContactNotes WHERE ContactId = '12345' AND Id = '56789'
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique identifier (id) for a given note. |
| ContactId [KEY] | String | False |
The unique identifier (id) for the contact included in the note. |
| ManageUserID | String | False |
The unique identifier (id) of the user managing the note. |
| CreateUserID | String | False |
The unique identifier (id) of the user who created the note. |
| IsPrivate | Boolean | False |
Indicator if the note is private. |
| NoteText | String | False |
Descriptive text of the note. |
| NoteTypeID | Long | False |
The id of the type of the note. |
| DisplayDate | Datetime | False |
Display date of the note. |
| Created | Datetime | False |
Datetime of the note creation. |
| Edited | Datetime | False |
Datetime of the last edit of the note. |
| AttachmentDisplayName | String | False |
Display name of the attachment. |
| AttachmentFileExtension | String | False |
File extension of the attachment. |
| AttachmentFileName | String | False |
File name of the attachment. |
| AttachmentFileSize | Long | False |
File size of the attachment. |
| AttachmentFileSizeDisplay | String | False |
Display file size of the attachment. |
| AttachmentFileType | String | False |
Type of the attachment file. |
| AttachmentLastModified | Datetime | False |
Last modified datetime of the attachment. |
| AttachmentPersonal | Boolean | False |
Indicator if the attachment is personal. |
| RecordManager | String | False |
Record Manager of the record. |
| RecordManagerID | String | False |
The record manager id of the record. |
| Companies | String | False |
List of companies that are associated to this note entity. |
| Contacts | String | False |
List of contacts that are associated to this note entity. |
| Groups | String | False |
List of groups that are associated to this note entity. |
| Opportunities | String | False |
List of opportunities that are associated to this note entity. |
Create, update, delete and query the Contacts in your Act! CRM database.
The Sync App uses the Act! CRM API to process search criteria that refer to the supported fields.
The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side:
SELECT * FROM Contacts WHERE Id = '12345' SELECT * FROM Contacts WHERE FullName = 'Full contact name'
To insert a contact, you need to specify the contact name.
INSERT INTO Contacts (FirstName) VALUES ('Contact First Name')
Any column where ReadOnly=False can be updated. Specify the Contact Id when updating a group
UPDATE Contacts SET Company = 'User Company' Website = 'UserWebsite.com' WHERE Id = '12345'
Contacts can be deleted by providing an Id and issuing a DELETE statement.
DELETE FROM Contacts WHERE Id = '12345'
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
The unique identifier (id) for this contact. |
| Created | Datetime | True |
Created date of the contact. |
| FullName | String | True |
The first name, any middle names, and surname of a contact. This may also include name prefixes and sufixes that are defined within Act! |
| Company | String | False |
The organization that this contact is associated with. |
| AltEmailAddress | String | False |
A unique electronic address that an individual can be contacted. |
| AlternateExtension | String | False |
The contact's alternate phone number extension. |
| AlternatePhone | String | False |
The contact's alternate phone number. |
| Birthday | Datetime | False |
The anniversary of the day on which a person was born. |
| BusinessAddressCity | String | False |
An inhabited place of greater size, population, or importance than a town or village. |
| BusinessAddressCountry | String | False |
A nation with its own government, occupying a particular territory. |
| BusinessAddressLine1 | String | False |
Primary street address |
| BusinessAddressLine2 | String | False |
Secondary street address |
| BusinessAddressLine3 | String | False |
Miscellaneous street address |
| BusinessAddressPostalCode | String | False |
A code of letters and digits added to a postal address to aid in the sorting of mail. |
| BusinessAddressState | String | False |
A nation or territory considered as an organized political community under one government. |
| BusinessExtension | String | False |
The contact's business phone number extension. |
| BusinessPhone | String | False |
The contact's business phone number. |
| CompanyID | String | False |
The unique identifier (companyID) for a given companies. |
| ContactType | String | True |
The type of contact: Contact, Secondary, or User. |
| Department | String | False |
An area of special expertise or responsibility. |
| Edited | Datetime | True |
Edited date of the contact. |
| EditedBy | String | True |
User who edited the contact. |
| EmailAddress | String | False |
A unique electronic address that an individual can be contacted. |
| FaxExtension | String | False |
The contact's fax phone number extension. |
| FaxPhone | String | False |
The contact's fax phone number. |
| FirstName | String | False |
A personal given name. |
| HomeAddressCity | String | False |
An inhabited place of greater size, population, or importance than a town or village. |
| HomeAddressCountry | String | False |
A nation with its own government, occupying a particular territory. |
| HomeAddressLine1 | String | False |
Primary street address |
| HomeAddressLine2 | String | False |
Secondary street address |
| HomeAddressLine3 | String | False |
Miscellaneous street address |
| HomeAddressPostalCode | String | False |
A code of letters and digits added to a postal address to aid in the sorting of mail. |
| HomeAddressState | String | False |
A nation or territory considered as an organized political community under one government. |
| HomeExtension | String | False |
The contact's home phone extension. |
| HomePhone | String | False |
The contact's home phone number. |
| IdStatus | String | False |
The relative social or professional position of an individual within a group or organization. |
| IsUser | Bool | True |
An indicator if this contact is also a user within the system. |
| JobTitle | String | False |
The title or position this contact holds. |
| LastName | String | False |
The family name or surname. |
| LastResults | String | False |
Identifies last communication or action with a contact. |
| Latitude | Decimal | False |
The angular distance of a place north or south of the earth's equator, or of a celestial object north or south of the celestial equator, usually expressed in degrees and minutes. |
| Longitude | Decimal | False |
The angular distance of a place east or west of the meridian at Greenwich, England, or west of the standard meridian of a celestial object, usually expressed in degrees and minutes. |
| MessengerID | String | True |
An online identifier alias. |
| MiddleName | String | False |
A name between one's first name and surname. |
| MobileExtension | String | False |
The contact's mobile phone extension. |
| MobilePhone | String | False |
The contact's mobile phone number. |
| NamePrefix | String | False |
A patronymic prefix. |
| NameSuffix | String | False |
Provides additional information about the person that identifies an individual position, educational degree, accreditation, orffice, or honors. |
| PagerExtension | String | False |
The contact's pager phone number extension |
| PagerPhone | String | False |
The contact's pager phone number. |
| PersonalEmailAddress | String | False |
A unique electronic address that an individual can be contacted. |
| RecordOwner | String | True |
Owner user of the contact. |
| ReferredBy | String | False |
Indiciates how this contact came about. |
| Salutation | String | True |
A gesture or utterance made as a greeting or acknowledgment. |
| Website | String | False |
The contact's web site. |
| IsFavorite | Bool | False |
Assign this contact as a favorite. |
| IsImported | Bool | False |
Identifies last communication or action with a contact. |
| ImportDate | Datetime | False |
This readonly property displays the date that the opportunity was imported into the system. |
| IsPrivate | Bool | False |
Identifies last communication or action with a contact. |
| LastEmail | String | False |
Last email. |
| LastAttempt | String | False |
Last attempt. |
| LastReach | String | False |
Last reach. |
| LastMeeting | String | False |
Last meeting. |
| LastLetterSent | String | False |
Last letter sent. |
| AmaScore | Int | False |
The contact's. |
| BusinessAddressLatitude | Decimal | False |
Business address latitude. |
| BusinessAddressLongitude | Decimal | False |
Business address longitude. |
| BusinessCountryCode | Int | False |
The contact's business phone country code. |
| BusinessMaskFormat | String | False |
The contact's business phone mask format. |
| MobileCountryCode | Int | False |
The contact's mobile phone country code. |
| MobileMaskFormat | String | False |
The contact's mobile phone mask format. |
| FaxCountryCode | Int | False |
The contact's fax phone country code. |
| FaxMaskFormat | String | False |
The contact's fax phone mask format. |
| HomeAddressLatitude | Decimal | False |
Home address latitude. |
| HomeAddressLongitude | Decimal | False |
Home address longitude. |
| HomeCountryCode | Int | False |
The contact's home phone country code. |
| HomeMaskFormat | String | False |
The contact's home phone mask format. |
| AlternateCountryCode | Int | False |
The contact's alternate phone country code. |
| AlternateMaskFormat | String | False |
The contact's alternate phone mask format. |
| PagerCountryCode | Int | False |
The contact's pager phone country code. |
| PagerMaskFormat | String | False |
The contact's pager phone mask format. |
| AemOptOut | Bool | False |
AemOptOut. |
| AemBounceBack | Bool | False |
AemBounceBack. |
| RecordManagerId | String | False |
The record manager. |
| QuickBooksId | String | False |
Quickbooks external Id to match record with quickbooks contact. |
| NylasContactId | String | False |
Nylas contact Id to match record with a contact. |
| CustomFields | String | False |
Custom fields. |
| RecordManager | String | False |
Record manager. |
Query and delete the Contacts belonging to a Group.
SELECT * FROM GroupContacts WHERE GroupId = '12345' SELECT * FROM GroupContacts WHERE FullName = 'Contact name'
GroupContacts can be deleted by providing GroupId and Id (Contact Id) and issuing a DELETE statement.
DELETE FROM GroupContacts WHERE GroupId = '12345' AND Id = '56789'
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique identifier (id) for this contact. |
| GroupId [KEY] | String | False |
The unique identifier (id) of the group to retrieve contacts from. |
| Created | Datetime | False |
Created date of the group. |
| FullName | String | False |
The first name, any middle names, and surname of a contact. This may also include name prefixes and sufixes that are defined within Act! |
| AltEmailAddress | String | False |
A unique electronic address that an individual can be contacted. |
| AlternateExtension | String | False |
The contact's alternate phone number extension. |
| AlternatePhone | String | False |
The contact's alternate phone number. |
| Birthday | Datetime | False |
The anniversary of the day on which a person was born. |
| BusinessAddressCity | String | False |
An inhabited place of greater size, population, or importance than a town or village. |
| BusinessAddressCountry | String | False |
A nation with its own government, occupying a particular territory. |
| BusinessAddressLine1 | String | False |
Primary street address |
| BusinessAddressLine2 | String | False |
Secondary street address |
| BusinessAddressLine3 | String | False |
Miscellaneous street address |
| BusinessAddressPostalCode | String | False |
A code of letters and digits added to a postal address to aid in the sorting of mail. |
| BusinessAddressState | String | False |
A nation or territory considered as an organized political community under one government. |
| BusinessExtension | String | False |
The contact's business phone number extension. |
| BusinessPhone | String | False |
The contact's business phone number. |
| Company | String | False |
The organization that this contact is associated with. |
| CompanyID | String | False |
The unique identifier (companyID) for a given companies. |
| ContactType | String | False |
The type of contact: Contact, Secondary, or User. |
| Department | String | False |
An area of special expertise or responsibility. |
| Edited | Datetime | False |
Edited date of the group. |
| EditedBy | String | False |
User who edited the group. |
| EmailAddress | String | False |
A unique electronic address that an individual can be contacted. |
| FaxExtension | String | False |
The contact's fax phone number extension. |
| FaxPhone | String | False |
The contact's fax phone number. |
| FirstName | String | False |
A personal given name. |
| HomeAddressCity | String | False |
An inhabited place of greater size, population, or importance than a town or village. |
| HomeAddressCountry | String | False |
A nation with its own government, occupying a particular territory. |
| HomeAddressLine1 | String | False |
Primary street address |
| HomeAddressLine2 | String | False |
Secondary street address |
| HomeAddressLine3 | String | False |
Miscellaneous street address |
| HomeAddressPostalCode | String | False |
A code of letters and digits added to a postal address to aid in the sorting of mail. |
| HomeAddressState | String | False |
A nation or territory considered as an organized political community under one government. |
| HomeExtension | String | False |
The contact's home phone extension. |
| HomePhone | String | False |
The contact's home phone number. |
| IdStatus | String | False |
The relative social or professional position of an individual within a group or organization. |
| IsUser | Bool | False |
An indicator if this contact is also a user within the system. |
| JobTitle | String | False |
The title or position this contact holds. |
| LastName | String | False |
The family name or surname. |
| LastResults | String | False |
Identifies last communication or action with a contact. |
| Latitude | Decimal | False |
The angular distance of a place north or south of the earth's equator, or of a celestial object north or south of the celestial equator, usually expressed in degrees and minutes. |
| Longitude | Decimal | False |
The angular distance of a place east or west of the meridian at Greenwich, England, or west of the standard meridian of a celestial object, usually expressed in degrees and minutes. |
| MessengerID | String | False |
An online identifier alias. |
| MiddleName | String | False |
A name between one's first name and surname. |
| MobileExtension | String | False |
The contact's mobile phone extension. |
| MobilePhone | String | False |
The contact's mobile phone number. |
| NamePrefix | String | False |
A patronymic prefix. |
| NameSuffix | String | False |
Provides additional information about the person that identifies an individual position, educational degree, accreditation, orffice, or honors. |
| PagerExtension | String | False |
The contact's pager phone number extension |
| PagerPhone | String | False |
The contact's pager phone number. |
| PersonalEmailAddress | String | False |
A unique electronic address that an individual can be contacted. |
| RecordOwner | String | False |
Owner user of the record. |
| ReferredBy | String | False |
Indiciates how this contact came about. |
| Salutation | String | False |
A gesture or utterance made as a greeting or acknowledgment. |
| Website | String | False |
The contact's web site. |
| IsFavorite | Bool | False |
Assign this contact as a favorite. |
| IsImported | Bool | False |
Identifies last communication or action with a contact. |
| ImportDate | Datetime | False |
This readonly property displays the date that the opportunity was imported into the system. |
| IsPrivate | Bool | False |
Identifies last communication or action with a contact. |
| LastEmail | String | False |
Last email. |
| LastAttempt | String | False |
Last attempt. |
| LastReach | String | False |
Last reach. |
| LastMeeting | String | False |
Last meeting. |
| LastLetterSent | String | False |
Last letter sent. |
| AmaScore | Int | False |
The contact's. |
| BusinessAddressLatitude | Decimal | False |
Business address latitude. |
| BusinessAddressLongitude | Decimal | False |
Business address longitude. |
| BusinessCountryCode | Int | False |
The contact's business phone country code. |
| BusinessMaskFormat | String | False |
The contact's business phone mask format. |
| MobileCountryCode | Int | False |
The contact's mobile phone country code. |
| MobileMaskFormat | String | False |
The contact's mobile phone mask format. |
| FaxCountryCode | Int | False |
The contact's fax phone country code. |
| FaxMaskFormat | String | False |
The contact's fax phone mask format. |
| HomeAddressLatitude | Decimal | False |
Home address latitude. |
| HomeAddressLongitude | Decimal | False |
Home address longitude. |
| HomeCountryCode | Int | False |
The contact's home phone country code. |
| HomeMaskFormat | String | False |
The contact's home phone mask format. |
| AlternateCountryCode | Int | False |
The contact's alternate phone country code. |
| AlternateMaskFormat | String | False |
The contact's alternate phone mask format. |
| PagerCountryCode | Int | False |
The contact's pager phone country code. |
| PagerMaskFormat | String | False |
The contact's pager phone mask format. |
| AemOptOut | Bool | False |
AemOptOut. |
| AemBounceBack | Bool | False |
AemBounceBack. |
| RecordManagerId | String | False |
The record manager. |
| QuickBooksId | String | False |
Quickbooks external Id to match record with quickbooks contact. |
| NylasContactId | String | False |
Nylas contact Id to match record with a contact. |
| CustomFields | String | False |
Custom fields. |
| RecordManager | String | False |
Record manager. |
Create, update, delete and query the Groups participating in your Act! CRM database.
SELECT * FROM Groups WHERE Name = 'Group name'
To insert a group, you need to specify the Group Name
INSERT INTO Groups (Name, Description) VALUES ('Group Name', 'This is sample group')
Any column where ReadOnly=False can be updated. Specify the Group Id when updating a group
UPDATE Groups SET isPrivate = false, AddressCity = 'Group City', AddressCountry = 'Group Country' WHERE Id = '12345'
Groups can be deleted by providing an Id and issuing a DELETE statement.
DELETE FROM Groups WHERE Id = '12345'
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
The unique identifier (id) for a group. |
| Created | Datetime | True |
A timestamp when this group was created |
| Name | String | False |
The name of the group. |
| AddressCity | String | False |
An inhabited place of greater size, population, or importance than a town or village. |
| AddressCountry | String | False |
A nation with its own government, occupying a particular territory. |
| AddressLine1 | String | False |
Primary street address |
| AddressLine2 | String | False |
Secondary street address |
| AddressLine3 | String | False |
Miscellaneous street address |
| AddressPostalCode | String | False |
A code of letters and digits added to a postal address to aid in the sorting of mail. |
| AddressState | String | False |
A nation or territory considered as an organized political community under one government. |
| AddressLatitude | Decimal | False |
The angular distance of a place north or south of the earth's equator, or of a celestial object north or south of the celestial equator, usually expressed in degrees and minutes. |
| AddressLongitude | Decimal | False |
The angular distance of a place east or west of the meridian at Greenwich, England, or west of the standard meridian of a celestial object, usually expressed in degrees and minutes. |
| Description | String | False |
A brief written respresentation of a group. |
| Edited | Datetime | True |
Edited date of the group. |
| EditedBy | String | True |
User who edited the group. |
| HierarchyLevel | Int | False |
The level this group appears in its hierarchy. |
| ParentID | String | True |
The group's parent entity. |
| HasSubgroups | Bool | False |
An indicator if this group contains subgroups. |
| RecordOwner | String | False |
Owner user of the record. |
| RecordManager | String | True |
Manager user of the record. |
| IsPrivate | Boolean | False |
Indicator if the group is private. |
| Contacts | Int | False |
Get the total number of contacts within the group. Contacts is nullable and hide it if the value is null. |
| ImportDate | Datetime | True |
This readonly property displays the date that the opportunity was imported into the system. |
| RecordManagerID | String | False |
The record manager. |
| CustomFields | String | False |
Custom fields. |
Get, Create, Update or Delete all history items.
SELECT * FROM Histories SELECT * FROM Histories where ID = '1234'
To insert a history, you must specify atleast one contact or company or opportunity or groups along with start time and end time.
INSERT INTO Histories (ContactsAggregate, StartTime, EndTime) VALUES ('9ff95080-7ca2-46ae-8161-04ac83bb20c5, 0ee7ab70-40df-4396-a7ef-132c7555e3ad', '2020-01-27 10:00:000', '2020-01-31 10:00:00')
Any column where ReadOnly=False can be updated. Specify the History Id when updating a group
UPDATE Histories SET Regarding = 'Test', isPrivate = false WHERE Id = '12345'
Histories can be deleted by providing an Id and issuing a DELETE statement.
DELETE FROM Histories WHERE Id = '12345'
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
Id of the history item created |
| AttachmentDisplayName | String | True |
Name of the attachment related to a history |
| AttachmentFileExtension | String | True |
FileExtension of the attachment related to a history |
| AttachmentFileName | String | True |
FileName of the attachment related to a history |
| AttachmentFileSize | Integer | True |
File Size of the attachment related to a history |
| AttachmentFileSizeDisplay | String | True |
File Size Display of the attachment related to a history |
| AttachmentFileType | String | True |
FileType of the attachment related to a history |
| AttachmentLastModified | Datetime | True |
File Last Modified date of the attachment related to a history |
| AttachmentPersonal | Boolean | True |
Attachment Personal |
| CompaniesAggregate | String | False |
Companies associated with a history |
| ContactsAggregate | String | False |
Contacts associated with a history |
| Created | Datetime | True |
The datetime when history was created |
| CreateUserID | String | True |
User Id of the user who craeted the history |
| Details | String | False |
Details of history |
| Duration | String | True |
Duration |
| Edited | Datetime | True |
Datetime when history was last edited |
| EndTime | Datetime | False |
End Time of history |
| GroupsAggregate | String | False |
Groups associated with history |
| HistoryTypeDescription | String | True |
Description of the type of history |
| HistoryTypeId | Integer | True |
History Type ID |
| HistoryTypeName | String | True |
Name of history type |
| TypeID | Integer | False |
Id of history type |
| IsPrivate | Boolean | False |
Indicates whether history is private or not |
| ManageUserID | String | True |
User Id of manager |
| OpportunitiesAggregate | String | False |
Opportunities associated with history |
| OutlookID | String | False |
Outlook Id |
| RecordManager | String | True |
Record Manager |
| RecordManagerID | String | True |
Id of Record Msnager |
| Regarding | String | False |
Tells what history is about |
| StartTime | Datetime | False |
Start Time |
Create, update, delete and query the Notes in your Act! CRM database.
The Sync App uses the Act! CRM API to process search criteria that refer to Id. (Note that the Id is a required criteria to query the Notes view)
The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side:
SELECT * FROM Notes WHERE Id = '2413d3d1-2345-6578-4859-792664d177af'
To insert a note, you must specify atleast one of the contacts, groups, companies or opportunities.
INSERT INTO Notes (NoteText, Contacts) VALUES ('This is sample note', ['123456'])
Any column where ReadOnly=False can be updated.
UPDATE Notes SET isPrivate = false WHERE Id = 123456
Notes can be deleted by providing an Id and issuing a DELETE statement.
DELETE FROM Notes WHERE Id = 123456
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
The unique identifier (id) for a given note. |
| ManageUserID | String | True |
The unique identifier (id) of the user managing the note. |
| CreateUserID | String | True |
The unique identifier (id) of the user who created the note. |
| IsPrivate | Boolean | False |
Indicator if the note is private. |
| NoteText | String | False |
Descriptive text of the note. |
| NoteTypeID | Long | True |
The id of the type of the note. |
| DisplayDate | Datetime | True |
Display date of the note. |
| Created | Datetime | True |
Datetime of the note creation. |
| Edited | Datetime | True |
Datetime of the last edit of the note. |
| AttachmentDisplayName | String | False |
Display name of the attachment. |
| AttachmentFileExtension | String | False |
File extension of the attachment. |
| AttachmentFileName | String | False |
File name of the attachment. |
| AttachmentFileSize | Long | False |
File size of the attachment. |
| AttachmentFileSizeDisplay | String | False |
Display file size of the attachment. |
| AttachmentLastModified | Datetime | False |
Last modified datetime of the attachment. |
| AttachmentFileType | String | False |
Type of the attachment file. |
| AttachmentPersonal | Boolean | False |
Indicator if the attachment is personal. |
| Companies | String | False |
List of companies that are associated to this note entity. |
| Contacts | String | False |
List of contacts that are associated to this note entity. |
| Groups | String | False |
List of groups that are associated to this note entity. |
| Opportunities | String | False |
List of opportunities that are associated to this note entity. |
| RecordManager | String | False |
Manager of the activity. |
| RecordManagerId | String | False |
The record manager. |
Create, update, delete and query the Opportunities in your Act! CRM database.
SELECT * FROM Opportunities WHERE Name = 'Opportunity name'
To insert a Opportunity, you must specify the Name and EstimatedCloseDate
INSERT INTO Opportunities (Name, EstimatedCloseDate) VALUES ('Sample Opportunity', '2020-01-30')
Any column where ReadOnly=False can be updated.
UPDATE Opportunities SET ContactsAggregate = '123456' WHERE Id = 'f3fd9661-8fab-4fe3-8321-225f2b770f60'
Opportunities can be deleted by providing an Id and issuing a DELETE statement.
DELETE FROM Opportunities WHERE Id = 'f3fd9661-8fab-4fe3-8321-225f2b770f60'
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
A unique identifier that represents the opportunity. |
| Created | Datetime | True |
Created date of the opportunity. |
| Name | String | False |
The opportunity name. |
| ActualCloseDate | Datetime | False |
The date that the opportunity as closed. |
| CompaniesAggregate | String | False |
List of companies that are associated to this opportunity entity. |
| Competitor | String | False |
Gets the name of the competitor for this opportunity. |
| ContactNames | String | False |
The names of the contacts associated with this opportunity. |
| ContactsAggregate | String | False |
The names of the contacts associated with this opportunity. |
| Creator | String | False |
Indicates elevated security that only the creator has access to this opportunity. |
| DaysOpen | Int | True |
The number of days this opportunity has been opened. |
| Edited | Datetime | True |
The date that this record was edited. |
| EditedBy | String | True |
The user's name that last editied this record. |
| EstimatedCloseDate | Datetime | False |
The date the opportunity is expected to be closed. |
| GrossMargin | Decimal | False |
Represents the net sales less the cost of goods and services sold. |
| GroupsAggregate | String | False |
List a groups that are associated to this opportunity entity. |
| IsPrivate | Bool | False |
Indicates whether this opportunity is private |
| Manager | String | False |
The name of the record manager of this opportunity. |
| OpenDate | Datetime | False |
The date the opportunity was opened. |
| Probability | Int | False |
The likelihood this opportunity will will be won by the close date. |
| ProductTotal | Decimal | False |
The total cost of the product or services. |
| Reason | String | False |
Describs why the opportunity status changed. |
| RecordOwner | String | False |
The user's name that owners this record. |
| RelatedEntitiesResolver | Bool | False |
If true prevents related entities from serializing. |
| Source | String | False |
Describs the source of the opportunity. |
| StageDescription | String | False |
Gets or sets the description of the stage. |
| StageId | String | False |
Gets the unique identifier of the stage. |
| StageName | String | False |
The name of the stage. |
| StageNumber | Int | False |
The ordinal number of the stage. |
| StageProbability | Int | False |
The probability of the stage. |
| StageProcessDescription | String | False |
The description of the stage process. |
| StageProcessId | String | False |
The unique identifier of the stage process. |
| StageProcessName | String | False |
The name of the stage process. |
| Status | String | False |
The status of the opportunity. |
| TotalPerCompany | Decimal | False |
The average total per associated company. |
| TotalPerContact | Decimal | False |
The average total per associated contact. |
| TotalPerGroup | Decimal | False |
The average total per associated group. |
| WeightedTotal | Decimal | False |
The weight of the product. |
| DaysInStage | Int | False |
The number of days this opportunity has been in a given stage. |
| StageStartDate | Datetime | False |
The date the opportunity stage started. |
| SourceId | String | False |
The external source id for the opportunity. |
| StageProcessStatus | String | False |
Stage process status. |
| StageProcessStagesCount | Int | False |
Stage process stages count |
| StageProcessStages | String | False |
Stage process stages |
| ImportDate | Datetime | True |
This readonly property displays the date that the opportunity was imported into the system. |
| QuickBooksInvoiceId | String | False |
Quickbooks external Id to match record with quickbooks contact. |
| RecordManagerId | String | False |
The record manager. |
| CustomFields | String | False |
Custom fields. |
| RecordManager | String | False |
Manager of the activity. |
Query and delete the Companies related to an Act! CRM opportunity.
SELECT * FROM OpportunityCompanies WHERE OpportunityId = '12345' SELECT * FROM OpportunityCompanies WHERE Name = 'Company name'
OpportunityCompanies can be deleted by providing an OpportunityId and Id (Company Id) and issuing a DELETE statement.
DELETE FROM OpportunityCompanies WHERE OpportunityId = '123456' AND Id = '345678'
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique identifier (id) for this company. |
| OpportunityId [KEY] | String | False |
The unique identifier of the opportunity the companies are related to. |
| Created | Datetime | False |
Created date of the company. |
| Name | String | False |
The company's given name. |
| AddressCity | String | False |
An inhabited place of greater size, population, or importance than a town or village. |
| AddressCountry | String | False |
A nation with its own government, occupying a particular territory. |
| AddressLine1 | String | False |
Primary street address |
| AddressLine2 | String | False |
Secondary street address |
| AddressLine3 | String | False |
Miscellaneous street address |
| AddressPostalCode | String | False |
A code of letters and digits added to a postal address to aid in the sorting of mail. |
| AddressState | String | False |
A nation or territory considered as an organized political community under one government. |
| BillingAddressCity | String | False |
An inhabited place of greater size, population, or importance than a town or village. |
| BillingAddressCountry | String | False |
A nation with its own government, occupying a particular territory. |
| BillingAddressLine1 | String | False |
Primary street address |
| BillingAddressLine2 | String | False |
Secondary street address |
| BillingAddressLine3 | String | False |
Miscellaneous street address |
| BillingAddressPostalCode | String | False |
A code of letters and digits added to a postal address to aid in the sorting of mail. |
| BillingAddressState | String | False |
A nation or territory considered as an organized political community under one government. |
| Description | String | False |
A brief written representation or account of this company. |
| Division | String | False |
The name of a smaller part of a parent company tasked with overseeing different types of products or services than those offered by the parent company. |
| Edited | Datetime | False |
Edited date of the company. |
| EditedBy | String | False |
User who edited the company. |
| Fax | String | False |
The company's fax phone number. |
| FaxExtension | String | False |
The company's fax phone number extension. |
| HierarchyLevel | Int | False |
The positional level of where this company lays within a company hierarchy. |
| IdStatus | String | False |
The relative social or professional position of an individual within a group or organization. |
| Industry | String | False |
Economic activity concerned with the processing of raw materials and manufacture of goods in factories. |
| NumberOfEmployees | Int | False |
The total number of employees that this company operates with. |
| ParentID | String | False |
The unique identifier (id) of the parent company. |
| Phone | String | False |
The company's phone number. |
| PhoneExtension | String | False |
The company's phone number extension. |
| RecordOwner | String | False |
Owner user of the record. |
| ReferredBy | String | False |
Mention or allude to. |
| Region | String | False |
A part of a country, of the world, etc., that is different or separate from other parts in some way. |
| Revenue | Decimal | False |
The amount of money that this company actually receives during a specific period, including discounts and deductions for returned merchandise. |
| ShippingAddressCity | String | False |
An inhabited place of greater size, population, or importance than a town or village. |
| ShippingAddressCountry | String | False |
A nation with its own government, occupying a particular territory. |
| ShippingAddressLine1 | String | False |
Primary street address |
| ShippingAddressLine2 | String | False |
Secondary street address |
| ShippingAddressLine3 | String | False |
Miscellaneous street address |
| ShippingAddressPostalCode | String | False |
A code of letters and digits added to a postal address to aid in the sorting of mail. |
| ShippingAddressState | String | False |
A nation or territory considered as an organized political community under one government. |
| SicCode | String | False |
Standard Industrial Classification (SIC) codes are four-digit numerical codes assigned by the U.S. government to business establishments to identify the primary business of the establishment. |
| Territory | String | False |
Geographical area. |
| TickerSymbol | String | False |
An arrangement of characters (usually letters) representing a particular security listed on an exchange or otherwise traded publicly. |
| TollFreeExtension | String | False |
The company's toll free phone number. |
| TollFreePhone | String | False |
The company's toll free phone number. |
| Website | String | False |
The company's website. |
| AddressLatitude | Decimal | False |
The address latitude. |
| AddressLongitude | Decimal | False |
The address longitude. |
| BillingAddressLatitude | Decimal | False |
The billing address latitude. |
| BillingAddressLongitude | Decimal | False |
The billing address longitude. |
| HasDivisions | Bool | False |
This readonly property indicates that this company has divisions. |
| ImportDate | Datetime | False |
This readonly property displays the date that the opportunity was imported into the system. |
| IsPrivate | Bool | False |
Indicates elevated security that only the creator/owner has access to this company. |
| RootParentId | String | False |
The unique identifier (id) of the parent company. |
| ShippingAddressLatitude | Decimal | False |
The shipping address latitude. |
| ShippingAddressLongitude | Decimal | False |
The shipping address longitude. |
| RecordManagerID | String | False |
The record manager. |
| CustomFields | String | False |
Custom fields. |
| RecordManager | String | False |
Manager of the activity. |
Query and delete the Contacts associated with an Opportunity.
SELECT * FROM OpportunityContacts WHERE OpportunityId = '12345' SELECT * FROM OpportunityContacts WHERE FullName = 'Contact name'
OpportunityContacts can be deleted by providing an OpportunityId and Id (Contact Id) and issuing a DELETE statement.
DELETE FROM OpportunityContacts WHERE OpportunityId = '12345' AND Id = '34567'
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique identifier (id) for this contact. |
| OpportunityId [KEY] | String | False |
The unique identifier (id) for the opportunity to query contacts from. |
| Created | Datetime | False |
Created date of the contact. |
| FullName | String | False |
The first name, any middle names, and surname of a contact. This may also include name prefixes and sufixes that are defined within Act! |
| AltEmailAddress | String | False |
A unique electronic address that an individual can be contacted. |
| AlternateExtension | String | False |
The contact's alternate phone number extension. |
| AlternatePhone | String | False |
The contact's alternate phone number. |
| Birthday | Datetime | False |
The anniversary of the day on which a person was born. |
| BusinessAddressCity | String | False |
An inhabited place of greater size, population, or importance than a town or village. |
| BusinessAddressCountry | String | False |
A nation with its own government, occupying a particular territory. |
| BusinessAddressLine1 | String | False |
Primary street address |
| BusinessAddressLine2 | String | False |
Secondary street address |
| BusinessAddressLine3 | String | False |
Miscellaneous street address |
| BusinessAddressPostalCode | String | False |
A code of letters and digits added to a postal address to aid in the sorting of mail. |
| BusinessAddressState | String | False |
A nation or territory considered as an organized political community under one government. |
| BusinessExtension | String | False |
The contact's business phone number extension. |
| BusinessPhone | String | False |
The contact's business phone number. |
| Company | String | False |
The organization that this contact is associated with. |
| CompanyID | String | False |
The unique identifier (companyID) for a given companies. |
| ContactType | String | False |
The type of contact: Contact, Secondary, or User. |
| Department | String | False |
An area of special expertise or responsibility. |
| Edited | Datetime | False |
Edited date of the contact. |
| EditedBy | String | False |
User who edited the contact. |
| EmailAddress | String | False |
A unique electronic address that an individual can be contacted. |
| FaxExtension | String | False |
The contact's fax phone number extension. |
| FaxPhone | String | False |
The contact's fax phone number. |
| FirstName | String | False |
A personal given name. |
| HomeAddressCity | String | False |
An inhabited place of greater size, population, or importance than a town or village. |
| HomeAddressCountry | String | False |
A nation with its own government, occupying a particular territory. |
| HomeAddressLine1 | String | False |
Primary street address |
| HomeAddressLine2 | String | False |
Secondary street address |
| HomeAddressLine3 | String | False |
Miscellaneous street address |
| HomeAddressPostalCode | String | False |
A code of letters and digits added to a postal address to aid in the sorting of mail. |
| HomeAddressState | String | False |
A nation or territory considered as an organized political community under one government. |
| HomeExtension | String | False |
The contact's home phone extension. |
| HomePhone | String | False |
The contact's home phone number. |
| IdStatus | String | False |
The relative social or professional position of an individual within a group or organization. |
| IsUser | Bool | False |
An indicator if this contact is also a user within the system. |
| JobTitle | String | False |
The title or position this contact holds. |
| LastName | String | False |
The family name or surname. |
| LastResults | String | False |
Identifies last communication or action with a contact. |
| Latitude | Decimal | False |
The angular distance of a place north or south of the earth's equator, or of a celestial object north or south of the celestial equator, usually expressed in degrees and minutes. |
| Longitude | Decimal | False |
The angular distance of a place east or west of the meridian at Greenwich, England, or west of the standard meridian of a celestial object, usually expressed in degrees and minutes. |
| MessengerID | String | False |
An online identifier alias. |
| MiddleName | String | False |
A name between one's first name and surname. |
| MobileExtension | String | False |
The contact's mobile phone extension. |
| MobilePhone | String | False |
The contact's mobile phone number. |
| NamePrefix | String | False |
A patronymic prefix. |
| NameSuffix | String | False |
Provides additional information about the person that identifies an individual position, educational degree, accreditation, orffice, or honors. |
| PagerExtension | String | False |
The contact's pager phone number extension |
| PagerPhone | String | False |
The contact's pager phone number. |
| PersonalEmailAddress | String | False |
A unique electronic address that an individual can be contacted. |
| RecordOwner | String | False |
Owner user of the record. |
| ReferredBy | String | False |
Indiciates how this contact came about. |
| Salutation | String | False |
A gesture or utterance made as a greeting or acknowledgment. |
| Website | String | False |
The contact's web site. |
| IsFavorite | Bool | False |
Assign this contact as a favorite. |
| IsImported | Bool | False |
Identifies last communication or action with a contact. |
| ImportDate | Datetime | False |
This readonly property displays the date that the opportunity was imported into the system. |
| IsPrivate | Bool | False |
Identifies last communication or action with a contact. |
| LastEmail | String | False |
Last email. |
| LastAttempt | String | False |
Last attempt. |
| LastReach | String | False |
Last reach. |
| LastMeeting | String | False |
Last meeting. |
| LastLetterSent | String | False |
Last letter sent. |
| AmaScore | Int | False |
The contact's. |
| BusinessAddressLatitude | Decimal | False |
The business address latitude. |
| BusinessAddressLongitude | Decimal | False |
The business address longitude. |
| BusinessCountryCode | Int | False |
The contact's business phone country code. |
| BusinessMaskFormat | String | False |
The contact's business phone mask format. |
| MobileCountryCode | Int | False |
The contact's mobile phone country code. |
| MobileMaskFormat | String | False |
The contact's mobile phone mask format. |
| FaxCountryCode | Int | False |
The contact's fax phone country code. |
| FaxMaskFormat | String | False |
The contact's fax phone mask format. |
| HomeAddressLatitude | Decimal | False |
The home address latitude. |
| HomeAddressLongitude | Decimal | False |
The home address longitude. |
| HomeCountryCode | Int | False |
The contact's home phone country code. |
| HomeMaskFormat | String | False |
The contact's home phone mask format. |
| AlternateCountryCode | Int | False |
The contact's alternate phone country code. |
| AlternateMaskFormat | String | False |
The contact's alternate phone mask. |
| PagerCountryCode | Int | False |
The contact's pager phone country code. |
| PagerMaskFormat | String | False |
The contact's pager phone mask. |
| AemOptOut | Bool | False |
AemOptOut. |
| AemBouncBack | Bool | False |
AemBouncBack. |
| RecordManagerID | String | False |
The record manager. |
| QuickbooksId | String | False |
Quickbooks external Id to match record with quickbooks contact. |
| NylasContactId | String | False |
Nylas contact Id to match record with a contact. |
| CustomFileds | String | False |
Custom fields. |
| RecordManager | String | False |
Manager of the activity. |
Query and delete the Act! CRM Groups associated with an Opportunity.
SELECT * FROM OpportunityGroups WHERE OpportunityId = '123456' SELECT * FROM OpportunityGroups WHERE Name = 'Group name'
OpportunityGroups can be deleted by providing an OpportunityId and Id (Group Id) and issuing a DELETE statement.
DELETE FROM OpportunityGroups WHERE OpportunityId = '123456' AND Id = '345678'
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
The unique identifier (id) for a group. |
| OpportunityId [KEY] | String | False |
The unique identifier (id) for the opportunity to retrieve groups from. |
| Created | Datetime | True |
A timestamp when this group was created |
| Name | String | True |
The name of the group. |
| AddressCity | String | True |
An inhabited place of greater size, population, or importance than a town or village. |
| AddressCountry | String | True |
A nation with its own government, occupying a particular territory. |
| AddressLine1 | String | True |
Primary street address |
| AddressLine2 | String | True |
Secondary street address |
| AddressLine3 | String | True |
Miscellaneous street address |
| AddressPostalCode | String | True |
A code of letters and digits added to a postal address to aid in the sorting of mail. |
| AddressState | String | True |
A nation or territory considered as an organized political community under one government. |
| Description | String | True |
A brief written respresentation of a group. |
| Edited | Datetime | True |
Edited date of the group. |
| EditedBy | String | True |
User who edited the group. |
| HierarchyLevel | Int | True |
The level this group appears in its hierarchy. |
| ParentID | String | True |
The group's parent entity. |
| RecordOwner | String | True |
Owner user of the record. |
| Contacts | Int | True |
Get the total number of contacts within the group. Contacts is nullable and hide it if the value is null. |
| HasSubgroups | Bool | True |
This readonly property indicates that this group has sub groups. |
| IsPrivate | Bool | True |
Indicates elevated security that only the creator/owner has access to this company. |
| ImportDate | Datetime | True |
This readonly property displays the date that the opportunity was imported into the system. |
| AddressLatitude | Decimal | True |
The address latitude. |
| AddressLongitude | Decimal | True |
The address longitude. |
| RecordManagerID | String | True |
The record manager. |
| CustomFields | String | True |
Custom fields. |
| RecordManager | String | True |
Manager of the activity. |
Update, delete and query the Products associated with an Opportunity.
SELECT * FROM OpportunityProducts WHERE OpportunityId = '12345' SELECT * FROM OpportunityProducts WHERE Name = 'Product name'
Any column where ReadOnly=False can be updated.
UPDATE OpportunityProducts SET ItemNumber = 'Product Item Number', Price = 40 WHERE OpportunityId = '12345' AND Id = '34567'
OpportunityProducts can be deleted by providing an OpportunityId and Id (Product Id) and issuing a DELETE statement.
DELETE FROM OpportunityProducts WHERE OpportunityId = '12345' AND Id = '34567'
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
A unique identifier (id) for a given product. |
| OpportunityId [KEY] | String | True |
A unique identifier (id) of the opportunity containing the products. |
| Created | Datetime | True |
A timestamp when this group was created |
| CreateDate | Datetime | True |
The date that the product was created. |
| Cost | Decimal | False |
The cost of the product. |
| EditDate | Datetime | True |
The date that the opportunity product was lasted modified. |
| ItemNumber | String | False |
A item number assigned to this opportunity product. |
| Name | String | False |
The name of the product. |
| Price | Decimal | False |
The price of the opportunity product. |
| Discount | Decimal | False |
The opportunity product's discounted percentage (ignore on updates). |
| DiscountPrice | Decimal | False |
The discounted price of the opportunity product. |
| ProductID | String | True |
A unique identifier (id) for a given product. |
| Quantity | Decimal | False |
The quantity of opportunity products. |
| Type | String | False |
The quantity of opportunity products. |
| IsQuickBooksproduct | Boolean | False |
Define is product linked with Quickbooks Product. |
| RecordOwner | String | False |
Record Owner. |
| RecordManager | String | False |
Record Manager. |
| Total | Decimal | False |
The total pricie of the opportunity product (adjusted price * quantity). |
| CustomFields | String | False |
Custom fields. |
| Edited | Datetime | False |
Edited. |
| EditedBy | String | False |
Edited by. |
Create, update, delete and query the Products in your Act! CRM database.
SELECT * FROM Products WHERE Name = 'Product name'
To insert a product, you need to specify the Product Name, Cost, Item Number and Price.
INSERT INTO Products (Name, Cost, ItemNumber, Price) VALUES ('Product 1', 10, 'PROD_1', 20)
Any column where ReadOnly=False can be updated.
UPDATE Products SET Cost = 20, Price = 30 WHERE Id = 12345
Products can be deleted by providing an Id and issuing a DELETE statement.
DELETE FROM Products WHERE Id = 12345
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
A unique identifier (id) for a given product. |
| CreateDate | Datetime | True |
The date that the product was created. |
| Name | String | False |
The name of the product. |
| Cost | Decimal | False |
The cost of the product. |
| EditDate | Datetime | True |
The date that the opportunity product was lasted modified. |
| ItemNumber | String | False |
A item number assigned to this opportunity product. |
| Price | Decimal | False |
The price of the opportunity product. |
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
| Name | Description |
| ActivityCompanies | Query the Companies participating in an Act! CRM Activity. |
| AnalyticsHistory | Gets historical e-marketing information for a given date range. |
| CampaignLeads | Gets contacts leads. |
| CampaignLeadsinfo | Gets opportunities within a campaign within a specified date range. |
| CampaignResults | Gets campaign result information. |
| CampaignSent | Gets campaign sent within a specified date range. |
| CloseReason | Generates opportunity data to summerizes how many times a reason has been closed. |
| CloseReasonDetails | Generates opportunity data to summerizes how many times a reason has been closed. |
| CompanyNotes | Query the Notes for a given Act! CRM Company. |
| ContactGroups | Query the Act! CRM Groups the Contact belongs to. |
| ContactHistories | Get all the history related to a contact. |
| ForecastByProduct | Generates forecasted opportunity data by given products. |
| ForecastByProductDetails | Generates forecasted opportunity data by a given product.. |
| ForecastByRep | Generates forecasted opportunity data by given users. |
| ForecastByRepDetails | Generates forecasted opportunity data by a given user. |
| GroupNotes | Query the Notes for a given Act! CRM Group. |
| OpportunityCount | Generates a summary of the total number of opportunities within a stage. |
| OpportunityNotes | Query the Notes for a given Act! CRM Opportunity. |
| Pipeline | Gets all opportunity matching the custom filter that are currently being worked. |
| RevenueActualVsPredicted | Generates actual vs predicted opportunity revenue. |
| RevenueCost | Generates opportunity periodic revenue versus cost data for given products. |
| RevenueWonVsLost | Generates opportunty win versus loss data. |
| SalesByProduct | Generates opportunity sales by product data for given products. |
| SalesByProductDetails | Generates opportunity sales by product detail data for a given product. |
| SalesByRep | Generates opportunity sales by user data for given users. |
| SalesByRepDetails | Generates opportunity sales by user data for a given user. |
| StageTime | Generates opportunity data for the average time in a stage. |
| UserActivities | Generates activity sales by user data for given users. |
| UserActivityDetails | Generated schema file. |
Query the Companies participating in an Act! CRM Activity.
SELECT * FROM ActivityCompanies WHERE ActivityId = '12345' SELECT * FROM ActivityCompanies WHERE Name = 'TSS Company'
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (id) for this company. |
| ActivityId [KEY] | String | A unique identifier that represents the activity the companies are part of. |
| Created | Datetime | Created date and the activity. |
| Name | String | The company's given name. |
| AddressCity | String | An inhabited place of greater size, population, or importance than a town or village. |
| AddressCountry | String | A nation with its own government, occupying a particular territory. |
| AddressLine1 | String | Primary street address |
| AddressLine2 | String | Secondary street address |
| AddressLine3 | String | Miscellaneous street address |
| AddressPostalCode | String | A code of letters and digits added to a postal address to aid in the sorting of mail. |
| AddressState | String | A nation or territory considered as an organized political community under one government. |
| BillingAddressCity | String | An inhabited place of greater size, population, or importance than a town or village. |
| BillingAddressCountry | String | A nation with its own government, occupying a particular territory. |
| BillingAddressLine1 | String | Primary street address |
| BillingAddressLine2 | String | Secondary street address |
| BillingAddressLine3 | String | Miscellaneous street address |
| BillingAddressPostalCode | String | A code of letters and digits added to a postal address to aid in the sorting of mail. |
| BillingAddressState | String | A nation or territory considered as an organized political community under one government. |
| Description | String | A brief written representation or account of this company. |
| Division | String | The name of a smaller part of a parent company tasked with overseeing different types of products or services than those offered by the parent company. |
| Edited | Datetime | Edited date of the activity. |
| EditedBy | String | User that edited the activity. |
| Fax | String | The company's fax phone number. |
| FaxExtension | String | The company's fax phone number extension. |
| HierarchyLevel | Int | The positional level of where this company lays within a company hierarchy. |
| IdStatus | String | The relative social or professional position of an individual within a group or organization. |
| Industry | String | Economic activity concerned with the processing of raw materials and manufacture of goods in factories. |
| NumberOfEmployees | Int | The total number of employees that this company operates with. |
| ParentID | String | The unique identifier (id) of the parent company. |
| Phone | String | The company's phone number. |
| PhoneExtension | String | The company's phone number extension. |
| RecordOwner | String | Owner of the activity. |
| ReferredBy | String | Mention or allude to. |
| Region | String | A part of a country, of the world, etc., that is different or separate from other parts in some way. |
| Revenue | Decimal | The amount of money that this company actually receives during a specific period, including discounts and deductions for returned merchandise. |
| ShippingAddressCity | String | An inhabited place of greater size, population, or importance than a town or village. |
| ShippingAddressCountry | String | A nation with its own government, occupying a particular territory. |
| ShippingAddressLine1 | String | Primary street address |
| ShippingAddressLine2 | String | Secondary street address |
| ShippingAddressLine3 | String | Miscellaneous street address |
| ShippingAddressPostalCode | String | A code of letters and digits added to a postal address to aid in the sorting of mail. |
| ShippingAddressState | String | A nation or territory considered as an organized political community under one government. |
| SicCode | String | Standard Industrial Classification (SIC) codes are four-digit numerical codes assigned by the U.S. government to business establishments to identify the primary business of the establishment. |
| Territory | String | Geographical area. |
| TickerSymbol | String | An arrangement of characters (usually letters) representing a particular security listed on an exchange or otherwise traded publicly. |
| TollFreeExtension | String | The company's toll free phone number. |
| TollFreePhone | String | The company's toll free phone number. |
| Website | String | The company's website. |
| AddressLatitude | Decimal | The angular distance of a place north or south of the earth's equator, or of a celestial object north or south of the celestial equator, usually expressed in degrees and minutes. |
| AddressLongitude | Decimal | The angular distance of a place east or west of the meridian at Greenwich, England, or west of the standard meridian of a celestial object, usually expressed in degrees and minutes. |
| BillingAddressLatitude | Decimal | The Billing address latitude. |
| BillingAddressLongitude | Decimal | The Billing address longitude. |
| HasDivisions | Boolean | This readonly property indicates that this company has divisions. |
| ImportDate | Datetime | This readonly property displays the date that the opportunity was imported into the system. |
| IsPrivate | Boolean | Indicates elevated security that only the creator/owner has access to this company. |
| RootParentId | String | The unique identifier (id) of the parent company. |
| ShippingAddressLatitude | Decimal | The Shipping address latitude. |
| ShippingAddressLongitude | Decimal | The Shipping address longitude. |
| RecordManagerID | String | The record manager. |
| CustomFields | String | Custom fields. |
| RecordManager | String | Manager of the activity. |
Gets historical e-marketing information for a given date range.
The Sync App will use the Act! CRM API to process WHERE clause conditions built with the following column and operator.
The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side:
SELECT * FROM AnalyticsHistory where Date > '2023-03-12' SELECT * FROM AnalyticsHistory
| Name | Type | Description |
| EmailActions | String | Email Actions |
| Sends | Integer | Count of mail sent |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Date | Datetime | Date Range of Activities By User |
Gets contacts leads.
The Sync App will use the Act! CRM API to process WHERE clause conditions built with the following column and operator.
The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side:
SELECT * FROM CampaignLeadsinfo where UserId = 'b7c23fa5-6cd3-4bcd-a036-f8bbb85ba760' SELECT * FROM CampaignLeadsinfo
| Name | Type | Description |
| AmaScore | Integer | Ama Score |
| BusinessEmail | String | Business Email |
| BusinessPhone | String | Business Phone |
| CompanyName | String | Company Name |
| ContactId | String | Contact Id |
| ContactName | String | Contact Name |
| Sends | Integer | Sends |
| TotalClicks | Integer | Total Clicks |
| TotalOpens | Integer | Total Opens |
| UniqueClicks | Integer | Unique Clicks |
| UniqueOpens | Integer | Unique Opens |
Gets opportunities within a campaign within a specified date range.
The Sync App will use the Act! CRM API to process WHERE clause conditions built with the following column and operator.
SELECT * FROM CampaignLeadsInfo where Date >= '2023-04-15' SELECT * FROM CampaignLeadsInfo
| Name | Type | Description |
| CampaignId | String | Campaign Id |
| CampaignName | String | Campaign Name |
| LeadCount | Integer | Lead Count |
| TotalValue | Integer | Total Value |
| WeightedValue | Integer | Weighted Value |
| Status | String | Staus |
| UserId | String | User Id |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Date | Datetime | Date Range of Activities By User |
Gets campaign result information.
The Sync App will use the Act! CRM API to process WHERE clause conditions built with the following column and operator.
The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side:
SELECT * FROM CampaignResults where Date >= '2023-03-12' and Date <= '2023-04-15' SELECT * FROM CampaignResults
| Name | Type | Description |
| CampaignDate | Datetime | Campaign Date |
| CampaignName | String | Campaign Name |
| Clicks | Integer | Clicks |
| Opens | Integer | Opens |
| Sends | Integer | Sends |
| UniqueClicks | Integer | Unique Clicks |
| UniqueSends | Integer | Unique Sends |
| CampaignId | String | Campaign Ids |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Date | Datetime | Date Range of Activities By User |
Gets campaign sent within a specified date range.
| Name | Type | Description |
| CampaignId | String | Campaign Id |
| CampaignName | String | Campaign Name |
| SendDate | Datetime | Send Date |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Date | Datetime | Date Range of Activities By User |
Generates opportunity data to summerizes how many times a reason has been closed.
The Sync App will use the Act! CRM API to process WHERE clause conditions built with the following column and operator. The Status is required to make a request and the rest of the filter is executed client-side within the Sync App
The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side:
SELECT * FROM CloseReason where Status = 'open'
| Name | Type | Description |
| Count | Integer | |
| Reason | String | |
| Status | String | Status of Activities
The allowed values are open, won, lost, inactive. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Date | Datetime | Date Range of Activities By User |
Generates opportunity data to summerizes how many times a reason has been closed.
The Sync App will use the Act! CRM API to process WHERE clause conditions built with the following column and operator. The Status and CloseReason are required to make a request and the rest of the filter is executed client-side within the Sync App
The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side:
SELECT * FROM CloseReasonDetails where Status = 'open' and CloseReason = 'Not specified'
| Name | Type | Description |
| OppId | String | Opp Id |
| OppName | String | Opp Name |
| ActualCloseDate | Datetime | Actual Close Date |
| ActualValue | Integer | Actual Value |
| CloseReason | String | Close Reason |
| Status | String | Status
The allowed values are open, won, lost, inactive. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Date | Datetime | Date Range of Activities By User |
Query the Notes for a given Act! CRM Company.
SELECT * FROM CompanyNotes WHERE CompanyId = '12345'
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (id) for a given note. |
| CompanyId [KEY] | String | The unique identifier (id) for the company included in the note. |
| ManageUserID | String | The unique identifier (id) of the user managing the note. |
| CreateUserID | String | The unique identifier (id) of the user who created the note. |
| IsPrivate | Boolean | Indicator if the note is private. |
| NoteText | String | Descriptive text of the note. |
| NoteTypeID | Long | The id of the type of the note. |
| DisplayDate | Datetime | Display date of the note. |
| Created | Datetime | Datetime of the note creation. |
| Edited | Datetime | Datetime of the last edit of the note. |
| AttachmentDisplayName | String | Display name of the attachment. |
| AttachmentFileExtension | String | File extension of the attachment. |
| AttachmentFileName | String | File name of the attachment. |
| AttachmentFileSize | Long | File size of the attachment. |
| AttachmentFileSizeDisplay | String | Display file size of the attachment. |
| AttachmentFileType | String | Type of the attachment file. |
| AttachmentLastModified | Datetime | Last modified datetime of the attachment. |
| AttachmentPersonal | Boolean | Indicator if the attachment is personal. |
| RecordManager | String | Record Manager. |
| RecordManagerId | String | Record Manager Id. |
| Companies | String | List of companies that are associated to this note entity. |
| Contacts | String | List of contacts that are associated to this note entity. |
| Groups | String | List of groups that are associated to this note entity. |
| Opportunities | String | List of opportunities that are associated to this note entity. |
Query the Act! CRM Groups the Contact belongs to.
SELECT * FROM ContactGroups WHERE ContactId = '12345' SELECT * FROM ContactGroups WHERE Name = 'Contact name'
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (id) for a group. |
| ContactId [KEY] | String | The unique identifier (id) for the contact included in the group. |
| Created | Datetime | A timestamp when this group was created |
| Name | String | The name of the group. |
| AddressCity | String | An inhabited place of greater size, population, or importance than a town or village. |
| AddressCountry | String | A nation with its own government, occupying a particular territory. |
| AddressLine1 | String | Primary street address |
| AddressLine2 | String | Secondary street address |
| AddressLine3 | String | Miscellaneous street address |
| AddressPostalCode | String | A code of letters and digits added to a postal address to aid in the sorting of mail. |
| AddressState | String | A nation or territory considered as an organized political community under one government. |
| Description | String | A brief written respresentation of a group. |
| Edited | Datetime | Edited date of the contact. |
| EditedBy | String | User who edited the contact. |
| HierarchyLevel | Int | The level this group appears in its hierarchy. |
| ParentID | String | The group's parent entity. |
| RecordOwner | String | Owner user of the record. |
| HasSubgroups | Boolean | This readonly property indicates that this group has sub groups. |
| RecordManager | String | Record Manager of the record. |
| RecordManagerID | String | The record manager id of the record. |
| ImportDate | Datetime | This readonly property displays the date that the opportunity was imported into the system. |
| IsPrivate | Boolean | Indicates elevated security that only the creator/owner has access to this company. |
| CustomFields | String | Custom fields. |
| AddressLatitude | Decimal | The Address latitude. |
| AddressLongitude | Decimal | The Address longitude. |
Get all the history related to a contact.
SELECT * FROM ContactHistories SELECT * FROM ContactHistories WHERE ContactId = '12345'
| Name | Type | Description |
| Id [KEY] | String | Id of the history item created |
| ContactId | String | Id of the contact |
| AttachmentDisplayName | String | Name of the attachment related to a history |
| AttachmentFileExtension | String | FileExtension of the attachment related to a history |
| AttachmentFileName | String | FileName of the attachment related to a history |
| AttachmentFileSize | Integer | File Size of the attachment related to a history |
| AttachmentFileSizeDisplay | String | File Size Display of the attachment related to a history |
| AttachmentFileType | String | FileType of the attachment related to a history |
| AttachmentLastModified | Datetime | File Last Modified date of the attachment related to a history |
| AttachmentPersonal | Boolean | Attachment Personal |
| CompaniesAggregate | String | Companies associated with a history |
| ContactsAggregate | String | Contacts associated with a history |
| Created | Datetime | The datetime when history was created |
| CreateUserID | String | User Id of the user who craeted the history |
| Details | String | Details of history |
| Duration | String | Duration |
| Edited | Datetime | Datetime when history was last edited |
| EndTime | Datetime | End Time of history |
| GroupsAggregate | String | Groups associated with history |
| HistoryTypeDescription | String | Description of the type of history |
| HistoryTypeId | Integer | History Type ID |
| HistoryTypeName | String | Name of history type |
| TypeID | Integer | Id of history type |
| IsPrivate | Boolean | Indicates whether history is private or not |
| ManageUserID | String | User Id of manager |
| OpportunitiesAggregate | String | Opportunities associated with history |
| OutlookID | String | Outlook Id |
| RecordManager | String | Record Manager |
| RecordManagerID | String | Id of Record Msnager |
| Regarding | String | Tells what history is about |
| StartTime | Datetime | Start Time |
Generates forecasted opportunity data by given products.
The Sync App will use the Act! CRM API to process WHERE clause conditions built with the following column and operator.
The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side:
SELECT * FROM ForecastByProduct
| Name | Type | Description |
| CountPercent | Decimal | Count Percent |
| OppCount | Integer | Opp Count |
| ProductId | String | Product ID |
| ProductName | String | Product Name |
| TotalValue | Decimal | Total Value |
| TotalValuePercent | Decimal | Total Value Percent |
| WeightedValue | Decimal | Weighted Value |
| WeightedValuePercent | Decimal | Weighted Value Percent |
Generates forecasted opportunity data by a given product..
The Sync App will use the Act! CRM API to process WHERE clause conditions built with the following column and operator. The ProductId is required to make a request and the rest of the filter is executed client-side within the Sync App.
The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side:
SELECT * FROM ForecastByProductDetails where Status = 'inactive'
| Name | Type | Description |
| EstCloseDate | Datetime | Est Close Date |
| OppName | String | Opp Name |
| ProbabilityPct | Integer | Probability Pct |
| ProductName | String | Product Name |
| ProductWeightedValue | Decimal | Product Weighted Value |
| Status | String | Status |
| ProductId | String | Product Id |
| OppId | String | Opp Id |
Generates forecasted opportunity data by given users.
The Sync App will use the Act! CRM API to process WHERE clause conditions built with the following column and operator.
The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side:
SELECT * FROM ForecastByRep where UserID = 'b7c23fa5-6cd3-4bcd-a036-f8bbb85ba760' SELECT * FROM ForecastByRep
| Name | Type | Description |
| CountPercent | Decimal | Count Percent |
| OppCount | Integer | Opp Count |
| SalesRep | String | Sales Rep |
| TotalValue | Decimal | Total Value |
| TotalValuePercent | Decimal | Total Value Percent |
| UserId | String | User Id |
| WeightedValue | Decimal | Weighted Value |
| WeightedValuePercent | Decimal | Weighted Value Percent |
Generates forecasted opportunity data by a given user.
The Sync App will use the Act! CRM API to process WHERE clause conditions built with the following column and operator. UserId is required to make a request and the rest of the filter is executed client-side within the Sync App.
The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side:
SELECT * FROM ForecastByRepDetails where UserID = 'b7c23fa5-6cd3-4bcd-a036-f8bbb85ba760'
| Name | Type | Description |
| EstCloseDate | Datetime | Est Close Date |
| OppName | String | Opp Name |
| ProbabilityPct | Integer | Probablity Pct |
| RepName | String | Rep Name |
| Status | String | Status |
| WeightedValue | Decimal | Weighted Value |
| UserId | String | User ID |
| OppId | String | Opp Id |
Query the Notes for a given Act! CRM Group.
SELECT * FROM GroupNotes WHERE GroupId = '12345'
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (id) for a given note. |
| GroupId [KEY] | String | The unique identifier (id) for the group included in the note. |
| ManageUserID | String | The unique identifier (id) of the user managing the note. |
| CreateUserID | String | The unique identifier (id) of the user who created the note. |
| IsPrivate | Boolean | Indicator if the note is private. |
| NoteText | String | Descriptive text of the note. |
| NoteTypeID | Long | The id of the type of the note. |
| DisplayDate | Datetime | Display date of the note. |
| Created | Datetime | Datetime of the note creation. |
| Edited | Datetime | Datetime of the last edit of the note. |
| AttachmentDisplayName | String | Display name of the attachment. |
| AttachmentFileExtension | String | File extension of the attachment. |
| AttachmentFileName | String | File name of the attachment. |
| AttachmentFileSize | Long | File size of the attachment. |
| AttachmentFileSizeDisplay | String | Display file size of the attachment. |
| AttachmentFileType | String | Type of the attachment file. |
| AttachmentLastModified | Datetime | Last modified datetime of the attachment. |
| AttachmentPersonal | Boolean | Indicator if the attachment is personal. |
| RecordManager | String | Record Manager of the record. |
| RecordManagerID | String | The record manager id of the record. |
| Companies | String | List of companies that are associated to this note entity. |
| Contacts | String | List of contacts that are associated to this note entity. |
| Groups | String | List of groups that are associated to this note entity. |
| Opportunities | String | List of opportunities that are associated to this note entity. |
Generates a summary of the total number of opportunities within a stage.
The Sync App will use the Act! CRM API to process WHERE clause conditions built with the following column and operator.
The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side:
SELECT * FROM OpportunityCount where Date = '2023-03-12' SELECT * FROM OpportunityCount
| Name | Type | Description |
| Count | Integer | Count |
| Ordinal | Integer | Ordinal |
| StageId | String | Stage Id |
| StageName | String | Stage Name |
| Value | Integer | Value |
| StartTime | Datetime | Start Time |
| EndTime | Datetime | End Time |
| DateType | Integer | Date Type |
| ValueType | Integer | Value Type |
| ProbabilityValue | Integer | Probability |
| ProbabilityOperation | String | Probability Operation |
| AmountValue | Decimal | Amount Value |
| AmountOperation | String | Amount Operation |
| OmitPrivate | Boolean | Omit Private |
| TypeId | String | Type Id |
| UserId | String | User Id |
| StageId | String | Stage Id |
| PickListItemId | String | Pick List Item Id |
| Status | String | Status |
Query the Notes for a given Act! CRM Opportunity.
SELECT * FROM OpportunityNotes WHERE OpportunityId = '12345'
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (id) for a given note. |
| OpportunityId [KEY] | String | The unique identifier (id) for the opportunity included in the note. |
| ManageUserID | String | The unique identifier (id) of the user managing the note. |
| CreateUserID | String | The unique identifier (id) of the user who created the note. |
| IsPrivate | Boolean | Indicator if the note is private. |
| NoteText | String | Descriptive text of the note. |
| NoteTypeID | Long | The id of the type of the note. |
| DisplayDate | Datetime | Display date of the note. |
| Created | Datetime | Datetime of the note creation. |
| Edited | Datetime | Datetime of the last edit of the note. |
| AttachmentDisplayName | String | Display name of the attachment. |
| AttachmentFileExtension | String | File extension of the attachment. |
| AttachmentFileName | String | File name of the attachment. |
| AttachmentFileSize | Long | File size of the attachment. |
| AttachmentFileSizeDisplay | String | Display file size of the attachment. |
| AttachmentFileType | String | Type of the attachment file. |
| AttachmentLastModified | Datetime | Last modified datetime of the attachment. |
| AttachmentPersonal | Boolean | Indicator if the attachment is personal. |
| RecordManager | String | Manager of the activity. |
| RecordManagerId | String | The record manager. |
| Companies | String | List of companies that are associated to this note entity. |
| Contacts | String | List of contacts that are associated to this note entity. |
| Groups | String | List of groups that are associated to this note entity. |
| Opportunities | String | List of opportunities that are associated to this note entity. |
Gets all opportunity matching the custom filter that are currently being worked.
The Sync App will use the Act! CRM API to process WHERE clause conditions built with the following column and operator.
The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side:
SELECT * FROM Pipeline
| Name | Type | Description |
| Id [KEY] | String | |
| CompanyName | String | Company Name |
| ContactCount | Integer | Contact Count |
| ContactDisplayName | String | Contact Display Name |
| EstCloseDate | Datetime | Est Close Date |
| Name | String | Name |
| ProbabilityPct | Integer | Probability Pct |
| StageId | String | Stage Id |
| StageName | String | Stage Name |
| TotalValue | Decimal | Total Value |
| WeightedValue | Decimal | Weighted Value |
| StartTime | Datetime | Start Time |
| EndTime | Datetime | End Time |
| DateType | Integer | Date Type |
| ValueType | Integer | Value Type |
| ProbabilityValue | Integer | Probability |
| ProbabilityOperation | String | Probability Operation |
| AmountValue | Decimal | Amount Value |
| AmountOperation | String | Amount Operation |
| OmitPrivate | Boolean | Omit Private |
| TypeId | String | Type Id |
| UserId | String | User ID |
| StageId | String | Stage Id |
| PickListItemId | String | Pick List Item Id |
| Status | String | Status |
Generates actual vs predicted opportunity revenue.
The Sync App will use the Act! CRM API to process WHERE clause conditions built with the following column and operator.
The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side:
SELECT * FROM RevenueActualVsPredicted
| Name | Type | Description |
| Actual | Integer | Actual |
| Potential | Integer | Potential |
| Projected | Integer | Projected |
| TimePeriod | String | Time Period |
| Interval | String | Interval
The allowed values are Daily, Weekly, Monthly, Quarterly, Yearly. |
| FiscalYearStart | Integer | Fiscal Year Start |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Date | Datetime | Date Range of Activities By User |
Generates opportunity periodic revenue versus cost data for given products.
SELECT * FROM RevenueCost where ProductId = 'b7c23fa5-6cd3-4bcd-a036-f8bbb85ba760' Select * FROM RevenueCost
| Name | Type | Description |
| AlternateText | String | Alternate Text |
| Cost | Integer | Cost |
| OppCount | Integer | Opp Count |
| Revenue | Integer | Revenue |
| TimePeriod | String | Time Period |
| ProductId | String | Product Id |
| Interval | String | Interval
The allowed values are daily, weekly, monthly, quarterly, yearly. |
| FiscalYearStart | Integer | Fiscal Year Start |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Date | Datetime | Date Range of Activities By User |
Generates opportunty win versus loss data.
The Sync App will use the Act! CRM API to process WHERE clause conditions built with the following column and operator.
The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side:
SELECT * FROM RevenueWonVsLost
| Name | Type | Description |
| Count | Integer | Count |
| CountPercent | Integer | Count Percent |
| Revenue | Decimal | Revenue |
| RevenuePercent | Integer | Revenue Percent |
| Status | String | Status |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Date | Datetime | Date Range of Activities By User |
Generates opportunity sales by product data for given products.
The Sync App will use the Act! CRM API to process WHERE clause conditions built with the following column and operator.
The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side:
SELECT * FROM SalesByProduct
| Name | Type | Description |
| Percent | Decimal | Percent |
| ProductId | String | Product Id |
| ProductName | String | Product Name |
| Revenue | Decimal | Revenue |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Date | Datetime | Date Range of Activities By User |
Generates opportunity sales by product detail data for a given product.
The Sync App will use the Act! CRM API to process WHERE clause conditions built with the following column and operator. ProductId is required to make a request and the rest of the filter is executed client-side within the Sync App.
The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side:
SELECT * FROM SalesByProductDetails where ProductId = 'b7c23fa5-6cd3-4bcd-a036-f8bbb85ba760'
| Name | Type | Description |
| ClosedDate | Datetime | Closed Date |
| OppName | String | Opp Name |
| ProductName | String | Product Name |
| ProductValue | Decimal | Product Value |
| ProductId | String | Product Id |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Date | Datetime | Date Range of Activities By User |
Generates opportunity sales by user data for given users.
The Sync App will use the Act! CRM API to process WHERE clause conditions built with the following column and operator.
The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side:
SELECT * FROM SalesByRep
| Name | Type | Description |
| CountPercent | Decimal | Count Percent |
| OppCount | Integer | Opp Count |
| Revenue | Decimal | Revenue |
| RevenuePercent | Decimal | Revenue Percent |
| SalesRep | String | Sales Rep |
| UserId | String | User Id |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Date | Datetime | Date Range of Activities By User |
Generates opportunity sales by user data for a given user.
The Sync App will use the Act! CRM API to process WHERE clause conditions built with the following column and operator. UserID is required to make a request and the rest of the filter is executed client-side within the Sync App
The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side:
SELECT * FROM SalesByRepDetails where UserId = 'b7c23fa5-6cd3-4bcd-a036-f8bbb85ba760'
| Name | Type | Description |
| ClosedDate | Datetime | Close Date |
| OppName | String | Opp Name |
| OppValue | Decimal | Opp Value |
| RepName | String | Rep Name |
| UserId | String | User Id |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Date | Datetime | Date Range of Activities By User |
Generates opportunity data for the average time in a stage.
The Sync App will use the Act! CRM API to process WHERE clause conditions built with the following column and operator.
The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side:
SELECT * FROM StageTime
| Name | Type | Description |
| AvgDays | Integer | Average Days |
| StageName | String | Stage Name |
| StageId | String | Stage Id |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Date | Datetime | Date Range of Activities By User |
Generates activity sales by user data for given users.
The Sync App will use the Act! CRM API to process WHERE clause conditions built with the following column and operator.
The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side:
SELECT * FROM UserActivities
| Name | Type | Description |
| ActivityCount | Integer | Activity Count |
| UserId | String | User Id |
| UserName | String | User Name |
| TypeId | String | Type Id |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Date | Datetime | Date Range of Activities By User |
Generated schema file.
The Sync App will use the Act! CRM API to process WHERE clause conditions built with the following column and operator. UserId is required to make a request and the rest of the filter is executed client-side within the Sync App.
The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side:
SELECT * FROM UserActivityDetails where UserId = 'b7c23fa5-6cd3-4bcd-a036-f8bbb85ba760'
| Name | Type | Description |
| ActivityId | String | Activity Id |
| ContactName | String | Contact Name |
| Location | String | Location |
| Regarding | String | Regarding |
| Type | String | Type |
| UserName | String | User Name |
| TypeId | String | Type Id |
| UserId | String | UserId |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Date | Datetime | Date Range of Activities By User |
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
| Property | Description |
| ActCloudRegion | The handle assigned to the Act! Premium Cloud account. |
| ActDatabase | The Act! Database to connect to. |
| URL | The URL of the ActCRM account. |
| ActEdition | The edition of ActCRM being used. Set either Act CRM or Act Premium Cloud. |
| User | Specifies the user ID of the authenticating Act! CRM user account. |
| Password | Specifies the password of the authenticating user account. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | The hostname or IP address of the proxy server that you want to route HTTP traffic through. |
| ProxyPort | The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | The username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | The password associated with the user specified in the ProxyUser connection property. |
| ProxySSLType | The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
| Property | Description |
| IncludeCustomFields | A boolean indicating if you would like to include custom fields in the column listing. |
| MaxRows | Specifies the maximum rows returned for queries without aggregation or GROUP BY. |
| Other | Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties. |
| Pagesize | Specifies the maximum number of results to return from Act! CRM, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property. |
| RowScanDepth | The maximum number of rows to scan to look for the columns available in a table. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout. |
| TypeDetectionScheme | Enables scanning Act! CRM Contact entities to determine unique columns. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
| Property | Description |
| ActCloudRegion | The handle assigned to the Act! Premium Cloud account. |
| ActDatabase | The Act! Database to connect to. |
| URL | The URL of the ActCRM account. |
| ActEdition | The edition of ActCRM being used. Set either Act CRM or Act Premium Cloud. |
| User | Specifies the user ID of the authenticating Act! CRM user account. |
| Password | Specifies the password of the authenticating user account. |
The handle assigned to the Act! Premium Cloud account.
ActCloudRegion is region in which the account is created in Act! Premium Cloud.
The API endpoint address depends on how you access your Act! Premium Cloud database. We need to use the regional API URL associated to the account. These are as follows:
US - https://apius.act.com
UK - https://apiuk.act.com
AUS/NZ - https://apiau.act.com
EU/International English - https://apieu.act.com
This property is only applied for Act! Premium Cloud connections, and must not be used if attempting to connect to an on-premise Act! Premium (Web) database.
The Act! Database to connect to.
If you are using Act! Premium for Desktop, the database name is shown at the top of the page, as Act! Premium - {DatabaseName}. If you are using Act! Premium Cloud, click the ? icon in the top right and select About Act! Premium. You will find the Database Name in the window that appears.
The URL of the ActCRM account.
The ActCRM URL is in the form http://{act crm instance}.com.
For Premium On-Premise this property should look like http://serverName/.
The edition of ActCRM being used. Set either Act CRM or Act Premium Cloud.
ActCloudRegion property needs to be filled only in Case of [Act Premium Cloud]. Default Region is US.
Specifies the user ID of the authenticating Act! CRM user account.
The authenticating server requires both User and Password to validate the user's identity.
Specifies the password of the authenticating user account.
The authenticating server requires both User and Password to validate the user's identity.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
Specifies the certificate to be accepted from the server when connecting using TLS/SSL.
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
| Description | Example |
| A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| A path to a local file containing the certificate | C:\cert.cer |
| The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
| The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
The following table provides port number information for each of the supported protocols.
| Protocol | Default Port | Description |
| TUNNEL | 80 | The port where the Sync App opens a connection to Act! CRM. Traffic flows back and forth via the proxy at this location. |
| SOCKS4 | 1080 | The port where the Sync App opens a connection to Act! CRM. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted. |
| SOCKS5 | 1080 | The port where the Sync App sends data to Act! CRM. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes. |
To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.
Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the TCP port to be used for a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Identifies the user ID of the account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the password of the user account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | The hostname or IP address of the proxy server that you want to route HTTP traffic through. |
| ProxyPort | The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | The username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | The password associated with the user specified in the ProxyUser connection property. |
| ProxySSLType | The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).
This connection property takes precedence over other proxy settings. Set to False if you want to manually configure the Sync App to connect to a specific proxy server.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
The hostname or IP address of the proxy server that you want to route HTTP traffic through.
The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.
The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
The Sync App only routes HTTP traffic through the proxy server port specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.
For other proxy types, see FirewallType.
Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
The authentication type can be one of the following:
For all values other than "NONE", you must also set the ProxyUser and ProxyPassword connection properties.
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
The username of a user account registered with the proxy server specified in the ProxyServer connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyUser |
| BASIC | The user name of a user registered with the proxy server. |
| DIGEST | The user name of a user registered with the proxy server. |
| NEGOTIATE | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NTLM | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NONE | Do not set the ProxyPassword connection property. |
The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the username specified in your system proxy settings.
The password associated with the user specified in the ProxyUser connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyPassword |
| BASIC | The password associated with the proxy server user specified in ProxyUser. |
| DIGEST | The password associated with the proxy server user specified in ProxyUser. |
| NEGOTIATE | The password associated with the Windows user account specified in ProxyUser. |
| NTLM | The password associated with the Windows user account specified in ProxyUser. |
| NONE | Do not set the ProxyPassword connection property. |
For SOCKS 5 authentication or tunneling, see FirewallType.
The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the password specified in your system proxy settings.
The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :
| AUTO | Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option. |
| ALWAYS | The connection is always SSL enabled. |
| NEVER | The connection is not SSL enabled. |
| TUNNEL | The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note that the Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
This property lets you customize the log file content by specifying the logging modules to include. Logging modules categorize logged information into distinct areas, such as query execution, metadata, or SSL communication. Each module is represented by a four-character code, with some requiring a trailing space for three-letter names.
For example, EXEC logs query execution, and INFO logs general provider messages. To include multiple modules, separate their names with semicolons as follows: INFO;EXEC;SSL.
The Verbosity connection property takes precedence over the module-based filtering specified by this property. Only log entries that meet the verbosity level and belong to the specified modules are logged. Leave this property blank to include all available modules in the log file.
For a complete list of available modules and detailed guidance on configuring logging, refer to the Advanced Logging section in Logging.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is %APPDATA%\\CData\\ActCRM Data Provider\\Schema, where %APPDATA% is set to the user's configuration directory:
| Platform | %APPDATA% |
| Windows | The value of the APPDATA environment variable |
| Linux | ~/.config |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.
Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.
If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.
Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.
If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| IncludeCustomFields | A boolean indicating if you would like to include custom fields in the column listing. |
| MaxRows | Specifies the maximum rows returned for queries without aggregation or GROUP BY. |
| Other | Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties. |
| Pagesize | Specifies the maximum number of results to return from Act! CRM, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property. |
| RowScanDepth | The maximum number of rows to scan to look for the columns available in a table. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout. |
| TypeDetectionScheme | Enables scanning Act! CRM Contact entities to determine unique columns. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file. |
A boolean indicating if you would like to include custom fields in the column listing.
Setting this to true will cause custom fields to be included in the column listing, but may cause poor performance when listing metadata.
Specifies the maximum rows returned for queries without aggregation or GROUP BY.
This property sets an upper limit on the number of rows the Sync App returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.
When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.
This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.
Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.
Note: It is strongly recommended to set these properties only when advised by the support team to address specific scenarios or issues.
Specify multiple properties in a semicolon-separated list.
| DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
| ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
| RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
Specifies the maximum number of results to return from Act! CRM, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
You may want to adjust the default pagesize to optimize results for a particular object or service endpoint you are querying. Be aware that increasing the page size may improve performance, but it could also result in higher memory consumption per page.
Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
This property allows you to define which pseudocolumns the Sync App exposes as table columns.
To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"
To include all pseudocolumns for all tables use: "*=*"
The maximum number of rows to scan to look for the columns available in a table.
The columns in a table must be determined by scanning table rows. This value determines the maximum number of rows that will be scanned.
Setting a high value may decrease performance. Setting a low value may prevent the data type from being determined properly, especially when there is null data.
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
This property controls the maximum time, in seconds, that the Sync App waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Sync App cancels the operation and throws an exception.
The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.
Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.
Enables scanning Act! CRM Contact entities to determine unique columns.
In the Act! CRM API, Contact entities can have different sets of associated attributes in addition to the standard columns.
To access these unique columns, set the following connection properties:
| RowScan | Setting TypeDetectionScheme to RowScan will scan objects (rows) to heuristically determine additional columns when you connect. The RowScanDepth determines the number of objects to be scanned. |
| None | Setting TypeDetectionScheme to None will return only the standard columns. |
Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
This property allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view. For example:
{
"MyView": {
"query": "SELECT * FROM Activities WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the Sync App.
Refer to User Defined Views for more information.