"SaleHistory"

•

Environment: onsite, online

• 16 minutes to read

This provider name is implemented by the class SuperOffice.CRM.ArchiveLists.SaleHistoryProvider inside NetServer's SODatabase assembly.

Sale histories. Contains all changes to the sale records over time.

Supported Entities

Name	Description
"sale"	Sale

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
completed	bool	Completed: Displays a checkbox showing if an appointment is completed	x
icon	listAny	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
updatedByFullName	associate	Updated by - Full name: 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
registeredByFullName	associate	Registered by - Full name: The user who registered the data	x
registeredDate	date	Registered date: The date/time the data was registered in UTC.	x
currencyId	int	Currency ID: The currency list item ID	x
currency	listAny	Currency: The currency of the sale	x
credited	listAny	Credited: The user to be credited with the sale	x
lossReason	listAny	Reason (lost: The reason for losing the sale	x
source	listAny	Source: The source (lead) of the sale	x
competitor	listAny	Competitor: The competitor who won the sale	x
heading	stringorPK	Sale: Displays a descriptive text for the item	x
amount	decimal	Amount: The gross sales total	x
amountWeighted	decimal	Weighted amount: Virtual field calculated from amount * probability percent.	x
earning	decimal	Profit: Gross profit (gross sales total - cost) for the sale	x
earningPercent	decimal	Profit as % : The profit as a percentage of the gross sales total	x
probPercent	int	Probability as %: Probability as %	x
stageWhenClosed	listAny	Stage when closed: Stage when closed
stage	listAny	Stage: Displays the stage of the sale
saleStatus	listAny	Status: The status of the sale - open, lost or sold	x
saleType	listAny	Sale type: Sale type, from list	x
nextDueDate	date	Next activity: Date for next activity for a sale, updated live from the sale's activities	x
reopenDate	date	Reopen date: Displays the reopen date for the sale	x
stalledComment	listAny	Reason (stalled: The reason the sale has been stalled	x
soldReason	listAny	Reason (sold: Reason (sold)	x
saleNumber	string	Number: Number	x
visibleFor	listAny	Visible for
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/usergroupId	int	Group ID: 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	Nickname: User's nickname 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	E-mail	x
associate/locationAddress	string	Location: Location	x
associate/isLocation	bool	Is a location: Is a location	x
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/personCountryId	int	Country ID: Country ID	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

Supported Columns (cont.)

Name	Restriction	Description	OrderBy
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/personUpdatedByFullName	associate	Updated by - Full name: 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/personRegisteredByFullName	associate	Registered by - Full name: 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/supportAssociateFullName	associate	Our service contact - Full name: Default service contact for this contact	x
person/personAssociateId	associate	Our contact: Displays our contact	x
person/personAssociateFullName	associate	Our contact - Full name: Displays our contact	x
person/personCategory	listAny	Category	x
person/personCategoryGroup	listAny	Category group	x
person/personCategoryRank	int	!!Category rank	x
person/personBusiness	listAny	Business	x
person/leadStatus	listAny	Lead status	x
person/leadstatusRank	int	!!Lead status RANK	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/updatedByWorkflow	listAny	Updated by flow: Updated by flow	x
person/whenUpdatedByWorkflow	datetime	When updated by flow: When updated by flow	x
person/createdByForm	listAny	Created by form: Created by form	x
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/categoryGroup	listAny	Category group	x
contact/companyCategoryRank	int	Category rank	x
contact/business	listAny	Business	x
contact/country	listAny	Country: This criterion corresponds to the Country field on the Company card.	x
contact/countryId	int	Country ID: Country ID	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/updatedByFullName	associate	Updated by - Full name: 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/registeredByFullName	associate	Registered by - Full name: 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/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/forceCompany	bool	Dummy: Dummy
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/statusRank	None	Status rank: Rank of the project status in the status list	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/updatedByFullName	associate	Updated by - Full name: 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/registeredByFullName	associate	Registered by - Full name: 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/project/textId	int	Text ID	x
project/project/infoText	positiveString	Information: Displays the text entered in the description field	x

Sample

GET /api/v1/archive/SaleHistory?$select=person/ticketPriority,contact/registeredBy,project/description
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: sv