"DiaryAppointment"
• 45 minutes to read
• 45 minutes to read
This provider name is implemented by the class
Archive provider for Appointment activities, of the Diary type (not followup or booking). This provider can be used on its own, or can form part of the
Supported Entities
Name | Description |
---|---|
"appointment" | Follow-ups |
Supported Columns
Name | Restriction | Description | OrderBy |
---|---|---|---|
getAllRows | bool | GetAll: Get all rows of archive - use with care, you may be fetching the whole database | |
getNoRows | bool | GetNone: Do not get any rows from the archive | |
participating | bool | Participating?: Am I among the participants in a meeting? | |
completed | bool | Completed: Displays a checkbox showing if an appointment is completed | x |
icon | None | Category: Displays the icon for an activity type | x |
date | date | Date: Displays start date of a follow-up / sale date of a sale | x |
time | None | Time: Time | |
type | listAny | Type: Displays the type of an activity | x |
recordType | string | Record type : Shows the record type | x |
text | positiveString | Text: Displays a descriptive text for the item | x |
associateId | associate | ID: Displays the login ID of the associate who owns the activity. | x |
contactId | listAny | Company ID: Database ID of company | x |
personId | listAny | Contact ID: Database ID of the contact row | x |
projectId | listAny | Project ID: Database ID of project record | x |
saleId | int | Sale ID: The database ID of the sale record | x |
userGroup | userGroup | User group : The user group that owns the record | x |
who | None | Who: Contact and/or company | |
updatedBy | associate | Updated by: The user who last updated the data | x |
updatedDate | date | Updated: The date/time the data was last updated in UTC. | x |
registeredBy | associate | Registered by: The user who registered the data | x |
registeredDate | date | Registered date: The date/time the data was registered in UTC. | x |
appointmentId | int | DB ID: Displays the database ID of a row | x |
endDate | date | End date: Displays the deadline for a follow-up/sale | x |
priority | listAny | Priority: Displays the priority of the activity | x |
alarm | bool | Has alarm: Displays the alarm state of a follow-up | x |
recurring | bool | Repeating: Displays an icon indicating if the follow-up is part of a repeating follow-up | x |
booking | bool | Invitation: Displays an icon if the follow-up is an invitation. All invitations will be displayed in a tooltip. | x |
intention | listAny | Intention: Displays the intention of the follow-up type | x |
location | string | Location: Display the location where the follow-up will take place. | x |
recurrenceRuleId | int | RR-ID: Repetition rule ID of follow-up | x |
rawType | int | Type: Type field for appointment, not decoded or formatted | x |
rawStatus | int | Status: Status field for the follow-up, not decoded or formatted | x |
cautionWarning | listAny | Warning: Warning for invitations with potential problems: not properly synchronized with an external calendar, unsupported repetition pattern, e-mail notification failed, or other problems. | x |
visibleInDiary | bool | ExcludeBook: Is the activity visible in the diary? | x |
endTime | None | End time: End time of an activity | |
suggestedAppointmentId | int | Follow-up ID (suggestion: The database ID of a follow-up that originates in a suggestion | x |
completedDate | date | Completed date: Displays the actual date a follow-up/sale was marked as completed | x |
isMilestone | bool | Milestone: Shows whether or not the follow-ups in this row are milestones | x |
invitedPersonId | int | ID of invited person: appointment.invitedpersonid record - utility for rd | x |
recordTypeText | None | Activity type: The type of the activity (appointment, phone call, etc) | x |
joinVideomeetUrl | None | Video meeting URL: URL for joining the video meeting | x |
visibleFor | listAny | Visible for | |
appointmentPublish/isPublished | bool | Published: Displays an icon indicating if the project or sale has been published | x |
appointmentPublish/publishedFrom | date | From date: Start date for publishing. The record will not be visible prior to this date | x |
appointmentPublish/publishedTo | date | To date: End date for publishing. The record will not be visible after this date | x |
appointmentPublish/publishedBy | None | Published by: Published by | |
contact/contactId | int | Company ID: Database ID of company | x |
contact/name | stringorPK | Company name | x |
contact/department | string | Department | x |
contact/nameDepartment | None | Company: Displays the company an activity is linked to | x |
contact/hasInfoText | bool | Has note: Displays an icon indicating if there is additional information available about the contact | x |
contact/hasInterests | bool | Has interests: Displays an Icon indicating if the contact has active interests | x |
contact/associateId | associate | Our contact: Displays our contact | x |
contact/category | listAny | Category | x |
contact/business | listAny | Business | x |
contact/country | listAny | Country: This criterion corresponds to the Country field on the Company card. | x |
contact/number | string | Number | x |
contact/code | string | Code | x |
contact/orgnr | string | VAT No. | x |
contact/stop | bool | Stop | x |
contact/contactNoMail | bool | No mailings (company | x |
contact/updatedBy | associate | Updated by: The user who last updated the data | x |
contact/updatedDate | date | Updated: The date/time the data was last updated in UTC. | x |
contact/registeredBy | associate | Registered by: The user who registered the data | x |
contact/registeredDate | date | Registered date: The date/time the data was registered in UTC. | x |
contact/contactSource | listAny | Source: Source (Company) | x |
contact/contactDeleted | bool | Deleted: Deleted | x |
contact/phone/formattedNumber | string | Phone : Displays phone number | |
contact/activeErpLinks | bool | ERP connected: Is there an active ERP Sync? | x |
contact/deletedDate | datetime | Deleted date: Deleted date | |
contact/mainContact | None | Main contact: Main contact for this company | x |
contact/contactPhone/formattedNumber | string | Telephone - Phone: Displays phone number | |
contact/contactPhone/description | string | Telephone - Description: Phone number description | x |
contact/contactFax/formattedNumber | string | Fax - Phone: Displays phone number | |
contact/contactFax/description | string | Fax - Description: Phone number description | x |
contact/searchPhone/formattedNumber | string | Searchphone - Phone: Displays phone number | |
contact/searchPhone/description | string | Searchphone - Description: Phone number description | x |
contact/email/emailProtocol | string | Protocol: E-mail protocol, such as SMTP | x |
contact/email/emailAddress | string | x | |
contact/email/emailDescription | string | Description | x |
contact/email/emailId | int | ID | x |
contact/email/emailLastSent | datetime | Last sent: The date and time an e-mail was last sent to this address | x |
contact/email/emailBounceCount | int | Bounce count: Bounce count for this e-mail address | x |
contact/email/emailLastBounce | datetime | Last bounce: Date and time for last bounce to this e-mail address | x |
contact/email/emailHasBounced | bool | Has bounced: This checkbox is active if delivery to this e-mail address has failed. | x |
contact/postAddress/addressId | int | Postal address - Address ID: Database ID for the address record | x |
contact/postAddress/line1 | string | Postal address - Address 1: First line of the address | x |
contact/postAddress/line2 | string | Postal address - Address 2: Second line of the address | x |
contact/postAddress/line3 | string | Postal address - Address 3: Third line of the address | x |
contact/postAddress/county | string | Postal address - County: This criterion corresponds to the County field on the Company card. It will only be visible if required by a country's address format. | x |
contact/postAddress/city | string | Postal address - City: This criterion corresponds to the City field on the Company card. | x |
contact/postAddress/zip | string | Postal address - Postcode: This criterion corresponds to the Zip Code field on the Company card. | x |
contact/postAddress/state | string | Postal address - State: This criterion corresponds to the State field on the Company card. \It will only be visible if required by a country's address format. | x |
contact/postAddress/wgs84latitude | decimal | Postal address - Latitude: Latitude | x |
contact/postAddress/wgs84longitude | decimal | Postal address - Longitude: Longitude | x |
contact/postAddress/formattedAddress | None | Postal address - {formattedAddress}: {formattedAddress} | |
contact/postAddress/formattedMultiLineAddress | None | Postal address - {formattedAddress}: {formattedAddress} | |
contact/streetAddress/addressId | int | Street address - Address ID: Database ID for the address record | x |
contact/streetAddress/line1 | string | Street address - Address 1: First line of the address | x |
contact/streetAddress/line2 | string | Street address - Address 2: Second line of the address | x |
contact/streetAddress/line3 | string | Street address - Address 3: Third line of the address | x |
contact/streetAddress/county | string | Street address - County: This criterion corresponds to the County field on the Company card. It will only be visible if required by a country's address format. | x |
contact/streetAddress/city | string | Street address - City: This criterion corresponds to the City field on the Company card. | x |
contact/streetAddress/zip | string | Street address - Postcode: This criterion corresponds to the Zip Code field on the Company card. | x |
contact/streetAddress/state | string | Street address - State: This criterion corresponds to the State field on the Company card. \It will only be visible if required by a country's address format. | x |
contact/streetAddress/wgs84latitude | decimal | Street address - Latitude: Latitude | x |
contact/streetAddress/wgs84longitude | decimal | Street address - Longitude: Longitude | x |
contact/streetAddress/formattedAddress | None | Street address - {formattedAddress}: {formattedAddress} | |
contact/streetAddress/formattedMultiLineAddress | None | Street address - {formattedAddress}: {formattedAddress} | |
contact/restrictionAddress/addressId | int | Search address - Address ID: Database ID for the address record | x |
contact/restrictionAddress/line1 | string | Search address - Address 1: First line of the address | x |
contact/restrictionAddress/line2 | string | Search address - Address 2: Second line of the address | x |
contact/restrictionAddress/line3 | string | Search address - Address 3: Third line of the address | x |
contact/restrictionAddress/county | string | Search address - County: This criterion corresponds to the County field on the Company card. It will only be visible if required by a country's address format. | x |
contact/restrictionAddress/city | string | Search address - City: This criterion corresponds to the City field on the Company card. | x |
contact/restrictionAddress/zip | string | Search address - Postcode: This criterion corresponds to the Zip Code field on the Company card. | x |
contact/restrictionAddress/state | string | Search address - State: This criterion corresponds to the State field on the Company card. \It will only be visible if required by a country's address format. | x |
contact/restrictionAddress/wgs84latitude | decimal | Search address - Latitude: Latitude | x |
contact/restrictionAddress/wgs84longitude | decimal | Search address - Longitude: Longitude | x |
contact/restrictionAddress/formattedAddress | None | Search address - {formattedAddress}: {formattedAddress} | |
contact/restrictionAddress/formattedMultiLineAddress | None | Search address - {formattedAddress}: {formattedAddress} | |
contact/url/URLAddress | string | URL | x |
contact/url/URLDescription | string | Description | x |
contact/contactAssociate/firstName | string | First name: Displays the contact's first name | x |
contact/contactAssociate/lastName | string | Last name: Displays the contact's last name | x |
contact/contactAssociate/middleName | string | Middle Name : Displays the contact's middle name. | x |
contact/contactAssociate/fullName | string | Full name: Displays full name of user (first, middle, last - according to settings) | x |
contact/contactAssociate/contactId | int | Company ID: Database ID of the company the user belongs to | |
contact/contactAssociate/personId | int | Contact ID: Database ID of the contact row | |
contact/contactAssociate/mrMrs | string | Mr/Ms: Displays whether the contact is addressed as Mr or Ms | x |
contact/contactAssociate/title | string | Title: Displays whether the contact is addressed as Mr or Ms | x |
contact/contactAssociate/associateDbId | associate | ID | x |
contact/contactAssociate/contactName | string | Owning company: Name of the company the user belongs to | x |
contact/contactAssociate/contactDepartment | string | Owning department: Name of the department at the company the user belongs to | x |
contact/contactAssociate/usergroup | userGroup | Primary group: The user's primary user group | x |
contact/contactAssociate/contactFullName | string | Owner: Name and department of the company the user belongs to | x |
contact/contactAssociate/contactCategory | listAny | Category: Category | x |
contact/contactAssociate/role | listAny | Role : Role | x |
contact/contactAssociate/assocName | associate | User ID : User ID | x |
contact/contactAssociate/assocTooltip | string | Description : Description | |
contact/contactAssociate/assocType | listAny | Type: Type of user: associate, external user, system user, anonymous account | x |
contact/contactAssociate/ejUserId | int | Service user ID: The database ID of a Service user | |
contact/contactAssociate/simultaneousEjUser | bool | Simultaneous Service user: If this flag is set, then the user will only have access if the maximum number of simultaneous users is not exceeded | |
contact/contactAssociate/ejDisplayName | string | Nick name: User's nick name in Service | x |
contact/contactAssociate/ejStatus | int | Service status: Status for Service user: Normal; Unavailable / holiday; Deleted; Read-only | |
contact/contactAssociate/credentialType | None | Auth. type: What type of credentials to use when this user logs in | x |
contact/contactAssociate/credentialDisplayValue | None | Auth. value: Credential value (public, visible part) to be used when this user logs in | x |
contact/contactAssociate/isActive | bool | Active: Is this user active, and should be able to log in? | x |
contact/contactAssociate/isActiveText | bool | Active status: Is this user active, and should be able to log in? | x |
contact/contactAssociate/portraitThumbnail | None | Person image: Person image | |
contact/contactAssociate/otherGroups | userGroup | Other groups: Other groups | |
contact/contactAssociate/userName | string | User name: User name | x |
contact/contactAssociate/personEmail | string | x | |
contact/contactInterestIds | listInterest | Company Interest: This criterion corresponds to the Interests tab on the Company card. | |
contact/contactUdef/SuperOffice:1 | string | companyshorttext: tooltipshorttext | x |
contact/contactUdef/SuperOffice:2 | string | companylongtext: tooltiplongtext | x |
contact/contactUdef/SuperOffice:3 | int | companynumber | x |
contact/contactUdef/SuperOffice:4 | date | companydate | x |
contact/contactUdef/SuperOffice:5 | unlimitedDate | companyunlimiteddate: tooltipunlimiteddate | x |
contact/contactUdef/SuperOffice:6 | bool | companycheckbox | x |
contact/contactUdef/SuperOffice:7 | listAny | companydropdownlistbox | x |
contact/contactUdef/SuperOffice:8 | decimal | companydecimal | x |
contact/contactUdef/SuperOffice:9 | string | page1saleonly | x |
contact/contactUdef/SuperOffice:10 | string | page1marketingonly | x |
contact/contactUdef/SuperOffice:11 | string | page1adminonly | x |
contact/contactUdef/SuperOffice:12 | listAny | Udlist one: Static tooltip for udlist one | x |
contact/contactUdef/SuperOffice:13 | listAny | Udlist two: Static tooltip for udlist two | x |
contact/NumberOfActivities | int | Number of activities | |
contact/NumberOfActivitiesInPeriod | int | Number of activities in last 90 days | |
contact/NumberOfNotCompletedActivities | int | Number of non-completed activities | |
contact/NumberOfNotCompletedActivitiesInPeriod | int | Number of non-completed activities in last 90 days | |
contact/LastActivity | date | Date of last activity | |
contact/LastCompletedActivity | date | Date of last completed activity | |
contact/LastDoByActivity | date | Date of last non-completed activity | |
contact/NumberOfSales | int | Number of sales | |
contact/NumberOfSalesInPeriod | int | Number of sales in last 90 days | |
contact/NumberOfNotCompletedSales | int | Number of non-completed sales | |
contact/NumberOfNotCompletedSalesInPeriod | int | Number of non-completed sales in last 90 days | |
contact/LastSale | date | Date of last sale | |
contact/LastCompletedSale | date | Date of last completed sale | |
contact/LastDoBySale | date | Date of last non-completed sale | |
contact/NumberOfTickets | int | Number of requests | |
contact/NumberOfTicketsInPeriod | int | Number of requests in last 90 days | |
contact/NumberOfNotCompletedTickets | int | Number of non-completed requests | |
contact/NumberOfNotCompletedTicketsInPeriod | int | Number of non-completed requests in last 90 days | |
contact/LastTicket | date | Date of last request | |
contact/LastCompletedTicket | date | Date of last completed request | |
contact/LastDoByTicket | date | Date of last non-completed request | |
contact/SaintStatus1 | saintStatus | Neglected customer | |
contact/SaintStatus2 | saintStatus | C-company | |
contact/saintSaleStatus | listAny | With status | |
contact/saintAmountClass | listAny | Amount class | |
contact/saintActivityType | listAny | SAINT type | |
contact/saintDirection | listAny | Direction | |
contact/saintIntention | listAny | Intention | |
contact/saintTicketStatus | listAny | Status | |
contact/saintTicketCategory | listAny | Category | |
person/personId | int | DB ID: Displays the database ID of a contact | x |
person/firstName | string | First name: Displays the contact's first name | x |
person/lastName | string | Last name: Displays the contact's last name | x |
person/middleName | string | Middle name: Displays the contact's middle name. | x |
person/fullName | stringorPK | Contact: Displays the contact to which an item is linked | x |
person/contactId | int | Company ID: Database ID of company | x |
person/hasInfoText | bool | Has note: Displays an icon indicating if there is additional information available about the contact | x |
person/hasInterests | bool | Has interests: Displays an Icon indicating if the contact has active interests | x |
person/personHasInterests | bool | Has interests: Displays an Icon indicating if the contact has active interests | x |
person/mrMrs | string | Mr/Ms: Displays whether the contact is addressed as Mr or Ms | x |
person/position | listAny | Position | x |
person/personNumber | string | Number: Displays the contact's number | x |
person/title | string | Title: Displays the contact's job title | x |
person/personCountry | listAny | Country: Country | x |
person/personNoMail | bool | No Mailings: Displays the contact's No Mailings checkbox | x |
person/rank | int | Rank: Displays a contact's current rank | x |
person/birthdate | None | Birthdate: Displays the contact's date of birth | |
person/associateType | None | User type: Displays an icon indicating if a contact is an associate or external contact with log-in rights and currently online. This information is updated only once while the archive is loading. | |
person/useAsMailingAddress | bool | Use as postal address: Use as postal address | x |
person/personSource | listAny | Source: Source (Contact) | x |
person/retired | bool | Former employee: Indicates whether the contact has retired/left the company | x |
person/birthYear | int | Birth year: Displays contact's birth year | x |
person/birthMonth | int | Birth month: Displays contact's birth month | x |
person/birthDay | int | Birth day: Displays contact's birth day (day of month) | x |
person/kanaFirstName | string | First name, kana: Contact's first name, in kana alphabet | x |
person/kanaLastName | string | Last name, kana: Contact's last name, in kana alphabet | x |
person/personUpdatedBy | associate | Updated by: The user who last updated the data | x |
person/personUpdatedDate | date | Updated: The date/time the data was last updated in UTC. | x |
person/personRegisteredBy | associate | Registered by: The user who registered the data | x |
person/personRegisteredDate | date | Registered date: The date/time the data was registered in UTC. | x |
person/portraitThumbnail | None | Person image: Person image | |
person/personActiveErpLinks | bool | ERP connected: Is there an active ERP Sync? | x |
person/ticketPriority | listAny | Service priority: Default service priority for this contact | x |
person/supportLanguage | listAny | Preferred language: Preferred language used for reply templates and more | x |
person/supportAssociate | associate | Our service contact: Default service contact for this contact | x |
person/personAssociateId | associate | Our contact: Displays our contact | x |
person/personCategory | listAny | Category | x |
person/personBusiness | listAny | Business | x |
person/personDeletedDate | datetime | Deleted date: Deleted date | |
person/hasCompany | bool | Has company: The contact is associated with a company | x |
person/isProjectMember | bool | Is project member: This person is a project member | x |
person/isStakeholder | bool | Is stakeholder: This person is a sale stakeholder | x |
person/phone/formattedNumber | string | Phone : Displays phone number | |
person/personDirectPhone/formattedNumber | string | Direct - Phone: Displays phone number | |
person/personDirectPhone/description | string | Direct - Description: Phone number description | x |
person/personMobilePhone/formattedNumber | string | Mobile - Phone: Displays phone number | |
person/personMobilePhone/description | string | Mobile - Description: Phone number description | x |
person/personPrivate/formattedNumber | string | Private - Phone: Displays phone number | |
person/personPrivate/description | string | Private - Description: Phone number description | x |
person/personPager/formattedNumber | string | Other - Phone: Displays phone number | |
person/personPager/description | string | Other - Description: Phone number description | x |
person/personDirectFax/formattedNumber | string | Fax - Phone: Displays phone number | |
person/personDirectFax/description | string | Fax - Description: Phone number description | x |
person/searchPhone/formattedNumber | string | Phone : Displays phone number | |
person/searchPhone/description | string | Description: Phone number description | x |
person/personInfo/textId | int | Text ID | x |
person/personInfo/infoText | positiveString | Information: Displays the text entered in the description field | x |
person/email/emailProtocol | string | Protocol: E-mail protocol, such as SMTP | x |
person/email/emailAddress | string | x | |
person/email/emailDescription | string | Description | x |
person/email/emailId | int | ID | x |
person/email/emailLastSent | datetime | Last sent: The date and time an e-mail was last sent to this address | x |
person/email/emailBounceCount | int | Bounce count: Bounce count for this e-mail address | x |
person/email/emailLastBounce | datetime | Last bounce: Date and time for last bounce to this e-mail address | x |
person/email/emailHasBounced | bool | Has bounced: This checkbox is active if delivery to this e-mail address has failed. | x |
person/personUrl/URLAddress | string | URL | x |
person/personUrl/URLDescription | string | Description | x |
person/personAddress/addressId | int | Contact address - Address ID: Database ID for the address record | x |
person/personAddress/line1 | string | Contact address - Address 1: First line of the address | x |
person/personAddress/line2 | string | Contact address - Address 2: Second line of the address | x |
person/personAddress/line3 | string | Contact address - Address 3: Third line of the address | x |
person/personAddress/county | string | Contact address - County: This criterion corresponds to the County field on the Company card. It will only be visible if required by a country's address format. | x |
person/personAddress/city | string | Contact address - City: This criterion corresponds to the City field on the Company card. | x |
person/personAddress/zip | string | Contact address - Postcode: This criterion corresponds to the Zip Code field on the Company card. | x |
person/personAddress/state | string | Contact address - State: This criterion corresponds to the State field on the Company card. \It will only be visible if required by a country's address format. | x |
person/personAddress/wgs84latitude | decimal | Contact address - Latitude: Latitude | x |
person/personAddress/wgs84longitude | decimal | Contact address - Longitude: Longitude | x |
person/personAddress/formattedAddress | None | Contact address - {formattedAddress}: {formattedAddress} | |
person/personAddress/formattedMultiLineAddress | None | Contact address - {formattedAddress}: {formattedAddress} | |
person/restrictionAddress/addressId | int | Search address - Address ID: Database ID for the address record | x |
person/restrictionAddress/line1 | string | Search address - Address 1: First line of the address | x |
person/restrictionAddress/line2 | string | Search address - Address 2: Second line of the address | x |
person/restrictionAddress/line3 | string | Search address - Address 3: Third line of the address | x |
person/restrictionAddress/county | string | Search address - County: This criterion corresponds to the County field on the Company card. It will only be visible if required by a country's address format. | x |
person/restrictionAddress/city | string | Search address - City: This criterion corresponds to the City field on the Company card. | x |
person/restrictionAddress/zip | string | Search address - Postcode: This criterion corresponds to the Zip Code field on the Company card. | x |
person/restrictionAddress/state | string | Search address - State: This criterion corresponds to the State field on the Company card. \It will only be visible if required by a country's address format. | x |
person/restrictionAddress/wgs84latitude | decimal | Search address - Latitude: Latitude | x |
person/restrictionAddress/wgs84longitude | decimal | Search address - Longitude: Longitude | x |
person/restrictionAddress/formattedAddress | None | Search address - {formattedAddress}: {formattedAddress} | |
person/restrictionAddress/formattedMultiLineAddress | None | Search address - {formattedAddress}: {formattedAddress} | |
person/personInterestIds | listInterest | Contact interest: This criterion corresponds to a contact's interests. It is available via the Contact dialog's Interests tab. | |
person/personUdef/SuperOffice:1 | string | contactshorttext: tooltipshorttext | x |
person/personUdef/SuperOffice:2 | string | contactlongtext: tooltiplongtext | x |
person/personUdef/SuperOffice:3 | int | contactnumber | x |
person/personUdef/SuperOffice:4 | date | contactdate | x |
person/personUdef/SuperOffice:5 | unlimitedDate | contactunlimiteddate: tooltipunlimiteddate | x |
person/personUdef/SuperOffice:6 | bool | contactcheckbox | x |
person/personUdef/SuperOffice:7 | listAny | contactdropdownlistbox | x |
person/personUdef/SuperOffice:8 | decimal | contactdecimal | x |
person/personUdef/SuperOffice:9 | string | page1saleonly | x |
person/personUdef/SuperOffice:10 | string | page1marketingonly | x |
person/personUdef/SuperOffice:11 | string | page1adminonly | x |
person/isMailingRecipient | bool | isMailingRecipient: isMailingRecipient | x |
person/hasStoreConsent | bool | Consent - Sales and service: The purpose to store data about this contact is to sell to and/or provide services to this contact. This purpose is usually used when storing contacts who are defined as potential or existing customers. | |
person/withdrawnStoreConsent | bool | Consent is withdrawn - Sales and service: The purpose to store data about this contact is to sell to and/or provide services to this contact. This purpose is usually used when storing contacts who are defined as potential or existing customers. | |
person/hasEmarketingConsent | bool | Consent - E-marketing: The purpose is to gain the explicit consent to communicate electronically (bulk e-mail) on topics related to our products and services. This might include newsletters, invitations and product-related content. The subscription system is used to refine the individual marketing choices this contact makes. | |
person/withdrawnEmarketingConsent | bool | Consent is withdrawn - E-marketing: The purpose is to gain the explicit consent to communicate electronically (bulk e-mail) on topics related to our products and services. This might include newsletters, invitations and product-related content. The subscription system is used to refine the individual marketing choices this contact makes. | |
person/subscription | listAny | Subscription: Subscription for marketing | x |
person/legalBaseStore | listAny | Legal basis - Sales and service: The purpose to store data about this contact is to sell to and/or provide services to this contact. This purpose is usually used when storing contacts who are defined as potential or existing customers. | x |
person/legalBaseEmarketing | listAny | Legal basis - E-marketing: The purpose is to gain the explicit consent to communicate electronically (bulk e-mail) on topics related to our products and services. This might include newsletters, invitations and product-related content. The subscription system is used to refine the individual marketing choices this contact makes. | x |
person/consentSourceStore | listAny | Source - Sales and service: The purpose to store data about this contact is to sell to and/or provide services to this contact. This purpose is usually used when storing contacts who are defined as potential or existing customers. | x |
person/consentSourceEmarketing | listAny | Source - E-marketing: The purpose is to gain the explicit consent to communicate electronically (bulk e-mail) on topics related to our products and services. This might include newsletters, invitations and product-related content. The subscription system is used to refine the individual marketing choices this contact makes. | x |
appointmentUdef/SuperOffice:1 | string | followupshorttext | x |
appointmentUdef/SuperOffice:2 | string | followuplongtext | x |
appointmentUdef/SuperOffice:3 | int | followupnumber | x |
appointmentUdef/SuperOffice:4 | date | followupdate | x |
appointmentUdef/SuperOffice:5 | unlimitedDate | followupunlimiteddate | x |
appointmentUdef/SuperOffice:6 | bool | followupcheckbox | x |
appointmentUdef/SuperOffice:7 | listAny | followupdropdownlistbox | x |
appointmentUdef/SuperOffice:8 | decimal | followupdecimal | x |
project/completed | bool | Completed: Displays a check mark indicating if the project has been completed. | x |
project/projectId | int | DB ID: Displays the database ID for a project row | x |
project/name | stringorPK | Project name: Displays the Project's name | x |
project/number | string | Number: Displays the project's number | x |
project/type | listAny | Project type: Displays the project's type | x |
project/status | listAny | Status: Displays the project's status | x |
project/associateId | associate | ID: Displays login ID of the associate who owns the project | x |
project/hasInfoText | bool | Info: Displays an icon indicating if the project has a description text. The text itself will be displayed in a tooltip. | x |
project/icon | None | Category: Displays the icon for an activity type | x |
project/text | string | Text: Displays a descriptive text for the item | x |
project/description | string | Description : Description | x |
project/updatedBy | associate | Updated by: The user who last updated the data | x |
project/updatedDate | date | Updated: The date/time the data was last updated in UTC. | x |
project/registeredBy | associate | Registered by: The user who registered the data | x |
project/registeredDate | date | Registered date: The date/time the data was registered in UTC. | x |
project/hasGuide | bool | Guided: Does this sale have a Sales Guide | x |
project/nextMilestone | date | Next milestone: Date of next non-completed activity that is marked as a milestone | x |
project/endDate | date | End date: End date of project | x |
project/imageThumbnail | None | Thumbnail: Scaled-down image of project image | |
project/activeErpLinks | bool | ERP connected: Is there an active ERP Sync? | x |
project/projectPublish/isPublished | bool | Published: Displays an icon indicating if the project or sale has been published | x |
project/projectPublish/publishedFrom | date | From date: Start date for publishing. The record will not be visible prior to this date | x |
project/projectPublish/publishedTo | date | To date: End date for publishing. The record will not be visible after this date | x |
project/projectPublish/publishedBy | None | Published by: Published by | |
project/projectEvent/isExternalEvent | bool | Event: Is this an external event | x |
project/projectEvent/eventDate | date | Event date: Event date | x |
project/projectEvent/hasSignOn | bool | Sign On: Does this event have the Sign On function enabled | x |
project/projectEvent/hasSignOff | bool | Sign Off: Does this event have the Sign Off function enabled | x |
project/projectUrl/URLAddress | string | URL | x |
project/projectUrl/URLDescription | string | Description | x |
project/projectAssociate/firstName | string | First name: Displays the contact's first name | x |
project/projectAssociate/lastName | string | Last name: Displays the contact's last name | x |
project/projectAssociate/middleName | string | Middle Name : Displays the contact's middle name. | x |
project/projectAssociate/fullName | string | Full name: Displays full name of user (first, middle, last - according to settings) | x |
project/projectAssociate/contactId | int | Company ID: Database ID of the company the user belongs to | |
project/projectAssociate/personId | int | Contact ID: Database ID of the contact row | |
project/projectAssociate/mrMrs | string | Mr/Ms: Displays whether the contact is addressed as Mr or Ms | x |
project/projectAssociate/title | string | Title: Displays whether the contact is addressed as Mr or Ms | x |
project/projectAssociate/associateDbId | associate | ID | x |
project/projectAssociate/contactName | string | Owning company: Name of the company the user belongs to | x |
project/projectAssociate/contactDepartment | string | Owning department: Name of the department at the company the user belongs to | x |
project/projectAssociate/usergroup | userGroup | Primary group: The user's primary user group | x |
project/projectAssociate/contactFullName | string | Owner: Name and department of the company the user belongs to | x |
project/projectAssociate/contactCategory | listAny | Category: Category | x |
project/projectAssociate/role | listAny | Role : Role | x |
project/projectAssociate/assocName | associate | User ID : User ID | x |
project/projectAssociate/assocTooltip | string | Description : Description | |
project/projectAssociate/assocType | listAny | Type: Type of user: associate, external user, system user, anonymous account | x |
project/projectAssociate/ejUserId | int | Service user ID: The database ID of a Service user | |
project/projectAssociate/simultaneousEjUser | bool | Simultaneous Service user: If this flag is set, then the user will only have access if the maximum number of simultaneous users is not exceeded | |
project/projectAssociate/ejDisplayName | string | Nick name: User's nick name in Service | x |
project/projectAssociate/ejStatus | int | Service status: Status for Service user: Normal; Unavailable / holiday; Deleted; Read-only | |
project/projectAssociate/credentialType | None | Auth. type: What type of credentials to use when this user logs in | x |
project/projectAssociate/credentialDisplayValue | None | Auth. value: Credential value (public, visible part) to be used when this user logs in | x |
project/projectAssociate/isActive | bool | Active: Is this user active, and should be able to log in? | x |
project/projectAssociate/isActiveText | bool | Active status: Is this user active, and should be able to log in? | x |
project/projectAssociate/portraitThumbnail | None | Person image: Person image | |
project/projectAssociate/otherGroups | userGroup | Other groups: Other groups | |
project/projectAssociate/userName | string | User name: User name | x |
project/projectAssociate/personEmail | string | x | |
project/projectUdef/SuperOffice:1 | string | projectshorttext | x |
project/projectUdef/SuperOffice:2 | string | projectlongtext | x |
project/projectUdef/SuperOffice:3 | int | projectnumber | x |
project/projectUdef/SuperOffice:4 | date | projectdate | x |
project/projectUdef/SuperOffice:5 | unlimitedDate | projectunlimiteddate | x |
project/projectUdef/SuperOffice:6 | bool | projectcheckbox | x |
project/projectUdef/SuperOffice:7 | listAny | projectdropdownlistbox | x |
project/projectUdef/SuperOffice:8 | decimal | projectdecimal | x |
project/projectUdef/SuperOffice:9 | int | page1saleandmarketing | x |
project/projectUdef/SuperOffice:10 | int | page1saleandadmin | x |
project/NumberOfActivities | int | Number of activities | |
project/NumberOfActivitiesInPeriod | int | Number of activities in last 90 days | |
project/NumberOfNotCompletedActivities | int | Number of non-completed activities | |
project/NumberOfNotCompletedActivitiesInPeriod | int | Number of non-completed activities in last 90 days | |
project/LastActivity | date | Date of last activity | |
project/LastCompletedActivity | date | Date of last completed activity | |
project/LastDoByActivity | date | Date of last non-completed activity | |
project/NumberOfSales | int | Number of sales | |
project/NumberOfSalesInPeriod | int | Number of sales in last 90 days | |
project/NumberOfNotCompletedSales | int | Number of non-completed sales | |
project/NumberOfNotCompletedSalesInPeriod | int | Number of non-completed sales in last 90 days | |
project/LastSale | date | Date of last sale | |
project/LastCompletedSale | date | Date of last completed sale | |
project/LastDoBySale | date | Date of last non-completed sale | |
project/SaintStatus3 | saintStatus | Not completed activites with intention sale | |
project/saintSaleStatus | listAny | With status | |
project/saintAmountClass | listAny | Amount class | |
project/saintActivityType | listAny | SAINT type | |
project/saintDirection | listAny | Direction | |
project/saintIntention | listAny | Intention | |
project/saintTicketStatus | listAny | Status | |
project/saintTicketCategory | listAny | Category | |
project/project/textId | int | Text ID | x |
project/project/infoText | positiveString | Information: Displays the text entered in the description field | x |
sale/completed | bool | Completed: Displays a checkbox showing if an appointment is completed | x |
sale/icon | None | Category: Displays the icon for an activity type | x |
sale/date | date | Date: Displays start date of a follow-up / sale date of a sale | x |
sale/time | None | Time: Time | |
sale/type | listAny | Type: Displays the type of an activity | x |
sale/recordType | string | Record type : Shows the record type | x |
sale/text | positiveString | Text: Displays a descriptive text for the item | x |
sale/associateId | associate | ID: Displays the login ID of the associate who owns the activity. | x |
sale/contactId | listAny | Company ID: Database ID of company | x |
sale/personId | listAny | Contact ID: Database ID of the contact row | x |
sale/projectId | listAny | Project ID: Database ID of project record | x |
sale/saleId | int | Sale ID: The database ID of the sale record | x |
sale/userGroup | userGroup | User group : The user group that owns the record | x |
sale/who | None | Who: Contact and/or company | |
sale/updatedBy | associate | Updated by: The user who last updated the data | x |
sale/updatedDate | date | Updated: The date/time the data was last updated in UTC. | x |
sale/registeredBy | associate | Registered by: The user who registered the data | x |
sale/registeredDate | date | Registered date: The date/time the data was registered in UTC. | x |
sale/currencyId | int | Currency ID: The currency list item ID | x |
sale/currency | listAny | Currency: The currency of the sale | x |
sale/credited | listAny | Credited: The user to be credited with the sale | x |
sale/lossReason | listAny | Reason (lost: The reason for losing the sale | x |
sale/source | listAny | Source: The source (lead) of the sale | x |
sale/competitor | listAny | Competitor: The competitor who won the sale | x |
sale/heading | stringorPK | Sale: Displays a descriptive text for the item | x |
sale/amount | decimal | Amount: The gross sales total | x |
sale/amountWeighted | decimal | Weighted amount: Virtual field calculated from amount * probability percent. | x |
sale/earning | decimal | Profit: Gross profit (gross sales total - cost) for the sale | x |
sale/earningPercent | decimal | Profit as % : The profit as a percentage of the gross sales total | x |
sale/probPercent | int | Probability as %: Probability as % | x |
sale/originalStage | listAny | Stage: Displays the stage of the sale | x |
sale/stage | listAny | Stage: Displays the stage of the sale | x |
sale/saleStatus | listAny | Status: The status of the sale - open, lost or sold | x |
sale/saleType | listAny | Sale type: Sale type, from list | x |
sale/nextDueDate | date | Next activity: Date for next activity for a sale, updated live from the sale's activities | x |
sale/reopenDate | date | Reopen date: Displays the reopen date for the sale | x |
sale/stalledComment | listAny | Reason (stalled: The reason the sale has been stalled | x |
sale/soldReason | listAny | Reason (sold: Reason (sold) | x |
sale/saleNumber | string | Number: Number | x |
sale/hasStakeholders | bool | Has stakeholders: Does this sale have stakeholders enabled | x |
sale/hasQuote | bool | Has quote?: Does the sale have a quote attached? | x |
sale/hasGuide | bool | Guided: Does this sale have a Sales Guide | x |
sale/description | string | Description: The long description field on Sale | |
sale/activeErpLinks | bool | ERP connected: Is there an active ERP Sync? | x |
sale/visibleFor | listAny | Visible for | |
sale/sale/textId | int | Text ID | x |
sale/sale/description | positiveString | Text: Displays the text entered in the description field | x |
sale/salePublish/isPublished | bool | Published: Displays an icon indicating if the project or sale has been published | x |
sale/salePublish/publishedFrom | date | From date: Start date for publishing. The record will not be visible prior to this date | x |
sale/salePublish/publishedTo | date | To date: End date for publishing. The record will not be visible after this date | x |
sale/salePublish/publishedBy | None | Published by: Published by | |
sale/associate/firstName | string | First name: Displays the contact's first name | x |
sale/associate/lastName | string | Last name: Displays the contact's last name | x |
sale/associate/middleName | string | Middle Name : Displays the contact's middle name. | x |
sale/associate/fullName | string | Full name: Displays full name of user (first, middle, last - according to settings) | x |
sale/associate/contactId | int | Company ID: Database ID of the company the user belongs to | |
sale/associate/personId | int | Contact ID: Database ID of the contact row | |
sale/associate/mrMrs | string | Mr/Ms: Displays whether the contact is addressed as Mr or Ms | x |
sale/associate/title | string | Title: Displays whether the contact is addressed as Mr or Ms | x |
sale/associate/associateDbId | associate | ID | x |
sale/associate/contactName | string | Owning company: Name of the company the user belongs to | x |
sale/associate/contactDepartment | string | Owning department: Name of the department at the company the user belongs to | x |
sale/associate/usergroup | userGroup | Primary group: The user's primary user group | x |
sale/associate/contactFullName | string | Owner: Name and department of the company the user belongs to | x |
sale/associate/contactCategory | listAny | Category: Category | x |
sale/associate/role | listAny | Role : Role | x |
sale/associate/assocName | associate | User ID : User ID | x |
sale/associate/assocTooltip | string | Description : Description | |
sale/associate/assocType | listAny | Type: Type of user: associate, external user, system user, anonymous account | x |
sale/associate/ejUserId | int | Service user ID: The database ID of a Service user | |
sale/associate/simultaneousEjUser | bool | Simultaneous Service user: If this flag is set, then the user will only have access if the maximum number of simultaneous users is not exceeded | |
sale/associate/ejDisplayName | string | Nick name: User's nick name in Service | x |
sale/associate/ejStatus | int | Service status: Status for Service user: Normal; Unavailable / holiday; Deleted; Read-only | |
sale/associate/credentialType | None | Auth. type: What type of credentials to use when this user logs in | x |
sale/associate/credentialDisplayValue | None | Auth. value: Credential value (public, visible part) to be used when this user logs in | x |
sale/associate/isActive | bool | Active: Is this user active, and should be able to log in? | x |
sale/associate/isActiveText | bool | Active status: Is this user active, and should be able to log in? | x |
sale/associate/portraitThumbnail | None | Person image: Person image | |
sale/associate/otherGroups | userGroup | Other groups: Other groups | |
sale/associate/userName | string | User name: User name | x |
sale/associate/personEmail | string | x | |
sale/saleUdef/SuperOffice:1 | string | saleshorttext | x |
sale/saleUdef/SuperOffice:2 | string | salelongtext | x |
sale/saleUdef/SuperOffice:3 | int | salenumber | x |
sale/saleUdef/SuperOffice:4 | date | saledate | x |
sale/saleUdef/SuperOffice:5 | unlimitedDate | saleunlimiteddate | x |
sale/saleUdef/SuperOffice:6 | bool | salecheckbox | x |
sale/saleUdef/SuperOffice:7 | listAny | saledropdownlistbox | x |
sale/saleUdef/SuperOffice:8 | decimal | saledecimal | x |
associate/firstName | string | First name: Displays the contact's first name | x |
associate/lastName | string | Last name: Displays the contact's last name | x |
associate/middleName | string | Middle Name : Displays the contact's middle name. | x |
associate/fullName | string | Full name: Displays full name of user (first, middle, last - according to settings) | x |
associate/contactId | int | Company ID: Database ID of the company the user belongs to | |
associate/personId | int | Contact ID: Database ID of the contact row | |
associate/mrMrs | string | Mr/Ms: Displays whether the contact is addressed as Mr or Ms | x |
associate/title | string | Title: Displays whether the contact is addressed as Mr or Ms | x |
associate/associateDbId | associate | ID | x |
associate/contactName | string | Owning company: Name of the company the user belongs to | x |
associate/contactDepartment | string | Owning department: Name of the department at the company the user belongs to | x |
associate/usergroup | userGroup | Primary group: The user's primary user group | x |
associate/contactFullName | string | Owner: Name and department of the company the user belongs to | x |
associate/contactCategory | listAny | Category: Category | x |
associate/role | listAny | Role : Role | x |
associate/assocName | associate | User ID : User ID | x |
associate/assocTooltip | string | Description : Description | |
associate/assocType | listAny | Type: Type of user: associate, external user, system user, anonymous account | x |
associate/ejUserId | int | Service user ID: The database ID of a Service user | |
associate/simultaneousEjUser | bool | Simultaneous Service user: If this flag is set, then the user will only have access if the maximum number of simultaneous users is not exceeded | |
associate/ejDisplayName | string | Nick name: User's nick name in Service | x |
associate/ejStatus | int | Service status: Status for Service user: Normal; Unavailable / holiday; Deleted; Read-only | |
associate/credentialType | None | Auth. type: What type of credentials to use when this user logs in | x |
associate/credentialDisplayValue | None | Auth. value: Credential value (public, visible part) to be used when this user logs in | x |
associate/isActive | bool | Active: Is this user active, and should be able to log in? | x |
associate/isActiveText | bool | Active status: Is this user active, and should be able to log in? | x |
associate/portraitThumbnail | None | Person image: Person image | |
associate/otherGroups | userGroup | Other groups: Other groups | |
associate/userName | string | User name: User name | x |
associate/personEmail | string | x | |
appointment/textId | int | Text ID | x |
appointment/description | positiveString | Text: Displays the text entered in the description field | x |
Sample
GET /api/v1/archive/DiaryAppointment?$select=contact/contactUdef/SuperOffice:3,person/withdrawnStoreConsent,project/nextMilestone,project/projectAssociate/userName,sale/userGroup
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: sv
See also: