Click or drag to resize

SOSale Interface

ISale Interface

Namespace:  SuperOffice.COM.SuperOfficeDB
Assembly:  SuperOfficeDB.Interop (in SuperOfficeDB.Interop.dll) Version: 8.0.0.0
Syntax
public interface SOSale : ISale

The SOSale type exposes the following members.

Properties
  NameDescription
Public propertyCode exampleActiveLinks
ActiveLinks - Number of active links to documents, projects, Urls, appointments, sales, contacts, persons, selections New in Seven.
(Inherited from ISale.)
Public propertyCode exampleActivityLinks
The ActivityLinks attached to this sale
(Inherited from ISale.)
Public propertyCode exampleAmount
Amount - changing this affects Earnings and/or Cost The total sale amount.
(Inherited from ISale.)
Public propertyCode exampleAmountAsFloat
AmountAsFloat - same as Amount property but with decimals - changing this affects Earnings and/or Cost The total sale amount. Same as Amount property, but with decimals
(Inherited from ISale.)
Public propertyCode exampleAppointment
Appointment
(Inherited from ISale.)
Public propertyCode exampleAssociate
Owning Associate
(Inherited from ISale.)
Public propertyCode exampleAutoSaveOnChangeIdentity
Should the model save on IdentityChanged?
(Inherited from ISale.)
Public propertyCode exampleAutoSaveOnFlush
Should the model save on flush cache?
(Inherited from ISale.)
Public propertyCode exampleChanged
has record been changed since read? If the sale has been modified since it was loaded, this will return false
(Inherited from ISale.)
Public propertyCode exampleCompetitor
Competitor Competitor is a list defined by the database administrator. It may be used to define different competitors in the market. From CRM 5 (Release 5.5) the field is visible in all states of a sale, in the first version it was only available when a sale was set to Lost.
(Inherited from ISale.)
Public propertyCode exampleCompleted
Completed A sale that has not been completed yet will, if the saledate has passed, be in the checklist of the owning associate.
(Inherited from ISale.)
Public propertyCode exampleContact
Contact the sale is linked to The contact associated with the sale. It may also be 0 if no contact is associated with the sale
(Inherited from ISale.)
Public propertyCode exampleCost
Cost - changing this affects Earnings and/or Amount The total cost of the sale. Changing this affects Earnings and/or Amount.
(Inherited from ISale.)
Public propertyCode exampleCreatedAssociate
The user that created the object The associate that first created the sale
(Inherited from ISale.)
Public propertyCode exampleCreatedDate
The date the object was saved to the database. The date and time the appointment was first created.
(Inherited from ISale.)
Public propertyCode exampleCredited
Credited Credited is a list defined by the database administrator. It could be used for defining different groups that should be credited for the sale, but this usage is not fixed the field only appears when the status is changed to sold. E.g. "Sale group 1".
(Inherited from ISale.)
Public propertyCode exampleCurrency
Currency - that Amount,Cost,Earning are denoted in It's possible to sell in different currencies. This will return the currency the sale object was sold in
(Inherited from ISale.)
Public propertyCode exampleDocumentLink
OBSOLETE - use ActivityLinks instead A sale might have a document linked to it.
(Inherited from ISale.)
Public propertyCode exampleEarning
Earning - changing this affects Amount and EarningPercent The profit on a sale, the amount left after the total cost of the sale is deducted
(Inherited from ISale.)
Public propertyCode exampleEarningPercent
EarningPercent - changing this affects Cost and Earning The profit on a sale, the amount left after the total cost of the sale is deducted The profit on a sale, the amount left after the total cost of the sale is deducted. Converted to a percentage of the amount.
(Inherited from ISale.)
Public propertyCode exampleExternalFieldChanged
have external fields been changed? New in Seven.
(Inherited from ISale.)
Public propertyCode exampleForeignKey
ForeignKey Get the foreign key values for this sale
(Inherited from ISale.)
Public propertyCode exampleGroup
User group of the owning associate. Set implicitly when the Associate property is set.
(Inherited from ISale.)
Public propertyCode exampleIdentity
The primary key on the primary table. Is zero for new objects. Is set when an object is saved. The database unique internal identity for the sale
(Inherited from ISale.)
Public propertyCode exampleIsAvailable
is record available in db? Checks if the record is available in the database. It’s useful to check if a sale actually exists before adding new properties to it
(Inherited from ISale.)
Public propertyIsFavourite
Add/Remove this sale from my favourites
(Inherited from ISale.)
Public propertyCode exampleIsRequiredFilled
Are all the required fields filled out? Can we save the record? Checks if all properties that are required in this model is filled
(Inherited from ISale.)
Public propertyCode exampleIsValid
does the record exist? To save time, we don't load a record into buffer before one of its properties is asked for. This checks if the requested record is available in buffer
(Inherited from ISale.)
Public propertyCode exampleNextDueDate
The next due date for the sale New in Seven.
(Inherited from ISale.)
Public propertyCode exampleNumber
Number The sales number, seen in GUI as the number on the Details panel of a sale
(Inherited from ISale.)
Public propertyCode exampleOurCurrency
OurCurrency - what we are converting amounts to It is possible to sell in different currencies. This will return the leading currency for this system, what do we currency are all sale converted into.
(Inherited from ISale.)
Public propertyCode examplePerson
Person the sale is linked to A sale may also be connected to a person - this must be a contact person registered on the current contact. This does not mean that a person is required.
(Inherited from ISale.)
Public propertyCode examplePostItText
Postit text New in Seven.
(Inherited from ISale.)
Public propertyCode examplePrivate
Visible for who? - 0=public,1=private,2=group The confidentiality of sale is shown as different types of private on the sale. For an updated list of "private" types, see the database manual.
(Inherited from ISale.)
Public propertyCode examplePrivateToGroup
Which user group is the sale visible for? Sets Private=2 automatically. The confidentiality of sale is shown as different types of private on the sale. For an updated list of "private" types, see the database manual.
(Inherited from ISale.)
Public propertyCode exampleProbability
Probability - the sale's success rating There is a predefined list of probabilities, but the user may change the probability percent. For example, if the customer has said he wants the product but has still not signed the contract, the normal probability could be set to 90 %. But, if the sales person knows that this customer is very reliable, he could change the probability to 100 %. Probability will then return 90.
(Inherited from ISale.)
Public propertyCode exampleProbabilityPercent
ProbabilityPercent - Likelyhood of success There is a predefined list of probabilities, but the user may change the probability percent. For example, if the customer has said he wants the product but has still not signed the contract, the normal probability could be set to 90 %. But, if the sales person knows that this customer is very reliable, he could change the probability to 100 %. Probability will then return 90. There is a predefined list of probabilities, but the user may change the probability percent. For example, if the customer has said he wants the product but has still not signed the contract, the normal probability could be set to 90 %. But, if the sales person knows that this customer is very reliable, he could change the probability to 100 %. ProbabilityPercent will then return 100.
(Inherited from ISale.)
Public propertyCode exampleProject
Project A sale may also be connected to a project, so you see the sale both on the company card, and on the project card. This does not mean that a project is required.
(Inherited from ISale.)
Public propertyCode examplePublishType
Publish type on sale
(Inherited from ISale.)
Public propertyCode exampleReason
Reason - why the sale was lost Reason is a list defined by the database administrator. It may be used to define different reasons for losing a sale the field only appears when the status is changed to "lost". For example, "our price was too high".
(Inherited from ISale.)
Public propertyCode exampleReasonLost
The reason why the sale was lost Reason is a list defined by the database administrator. It may be used to define different reasons for losing a sale the field only appears when the status is changed to "lost". For example, "our price was too high". New in Seven.
(Inherited from ISale.)
Public propertyCode exampleReasonSold
The reason why the sale was sold Reason is a list defined by the database administrator. It may be used to define different reasons for losing a sale the field only appears when the status is changed to "lost". For example, "our price was too high". New in Seven.
(Inherited from ISale.)
Public propertyCode exampleReasonStalled
The reason why the sale is stalled Reason is a list defined by the database administrator. It may be used to define different reasons for losing a sale the field only appears when the status is changed to "lost". For example, "our price was too high". New in Seven.
(Inherited from ISale.)
Public propertyCode exampleReopenDate
The reopen date for the sale New in Seven.
(Inherited from ISale.)
Public propertyCode exampleSaleDate
SaleDate - expected closing date The expected sales date for when the sale will be sold (or lost).
(Inherited from ISale.)
Public propertyCode exampleSaleText
SaleText - description of the sale The sales textbox - it may contain text describing the sale. Filled out by the user.
(Inherited from ISale.)
Public propertyCode exampleSaleType
The Sale Type for the sale New in Seven.
(Inherited from ISale.)
Public propertyCode exampleSentry
Sentry settings for this object. Lets you find out your read/write access to the object.
(Inherited from ISale.)
Public propertyCode exampleSource
Source - Where the sale originated Source is a list defined by the database administrator. It may be used to define different sources for obtaining a sale the field only appears when the status is changed to "sold". For example, a response from our website.
(Inherited from ISale.)
Public propertyCode exampleStage
Which stage is this sale in? New in Seven.
(Inherited from ISale.)
Public propertyStakeholders
Get the stakeholders for this sale.
(Inherited from ISale.)
Public propertyCode exampleStatus
Status - Open=1,Sold=2,Lost=3 The different statuses a sale may have - this is a fixed predefined list. See the database manual for an updated list of status types
(Inherited from ISale.)
Public propertySuggestedAppointments
Retrieves the collection of Suggested Appointments for this sale
(Inherited from ISale.)
Public propertySuggestedDocuments
Retrieves the collection of Suggested Documents for this sale
(Inherited from ISale.)
Public propertyCode exampleTitle
Title The sale title, in the database manual this is the same as sale.heading
(Inherited from ISale.)
Public propertyCode exampleUDef
UDef A collection of the sale panels user defined fields
(Inherited from ISale.)
Public propertyCode exampleUpdatedAssociate
The last user to modify the object The last associate that updated this sale. If the sale has never been updated, this will return 0
(Inherited from ISale.)
Public propertyCode exampleUpdatedDate
The date of the most recent update. The date and time the sale was last edited. If the sale has never been updated, this will return 0; formatted as a SuperOffice date (see the database manual), this will return 01.01.1970
(Inherited from ISale.)
Public propertyCode exampleValidationMessage
get validation message, if empty model will think it is ok to save New in Seven.
(Inherited from ISale.)
Top
Methods
  NameDescription
Public methodCode exampleCanBeCompleted
Can this sale be completed? (Based on status) New in Seven.
(Inherited from ISale.)
Public methodCode exampleCancelChanges
Undo any changes made since the object was loaded.
(Inherited from ISale.)
Public methodCode exampleChangeIdentity
Loads a different record into the object. Causes changes to the existing object to be saved first. Saves the changes made to the sale model to the database. The last thing you do to an object if you want the changes you made to be saved. The ChangeIdentity method calls the save method first.
(Inherited from ISale.)
Public methodClone
Clone this sale
(Inherited from ISale.)
Public methodCode exampleConvertToOurCurrency
ConvertToOurCurrency - converts parameter to our native currency - assumes Currency has been set Converts parameter to our native currency - assumes Currency has been set
(Inherited from ISale.)
Public methodCode exampleDelete
Delete the object from the database. May throw an error if you are not allowed to delete the object. Deletes the specified sale model from the database
(Inherited from ISale.)
Public methodGetActivityList (Inherited from ISale.)
Public methodCode exampleGetSuggestedAppointments
OBSOLETE: Use SuggestedAppointments property instead New in Seven.
(Inherited from ISale.)
Public methodCode exampleGetSuggestedDocuments
OBSOLETE: Use SuggestedDocuments property instead New in Seven.
(Inherited from ISale.)
Public methodIsGuided
Returns TRUE if the sale is guided
(Inherited from ISale.)
Public methodCode exampleSave
Persist the object to the database. May throw an error if you are not allowed to save changes to the object. Saves the changes you made to the sale model to the database
(Inherited from ISale.)
Public methodCode exampleSetDefaults
Populate the object with default values, such as setting the owner to the current user. Uses the UserPreferences table to set the predefined default settings for a sale. The SetDefaults method is only available for current objects in this version of SuperOfficeDB Type Library
(Inherited from ISale.)
Top
See Also