API Data Provider - Online Help

Opportunities

Sales opportunities tracked in HaloServiceDesk, representing potential deals and their progression through the sales pipeline.

Columns

Name Type References
Id [KEY] Integer
Summary String
Details String
DetailsHtml String
ChangeInformationHtml String
LastNote String
CurrentActionType String
CurrentActionName String
Warning String
StatusName String
AgentName String
RequestTypeName String
SLAName String
PriorityName String
WorkflowName String
UsersName String
BudgetTypeName String
ParentSummary String
ClientId Integer

Clients.Id

ClientName String
SiteId Integer

Sites.Id

SiteName String
UserId Integer

Users.Id

UserName String
UserEmail String
AgentId Integer

Agents.Id

Team String
TeamId Integer

Teams.Id

TeamDepartmentId Integer
OrganisationId Integer
DepartmentId Integer
ParentId Integer

Opportunities.Id

TopLevelId Integer
TakenBy String
ReportedBy String
LoggedOnBehalfBy String
PhoneNumber String
PhoneNumberFrom String
AlternativeContactNo String
EmailToList String
EmailCcList String
CcAddress String
AlsoInform String
EmailDisplayName String
DeliveryContact String
AddressFrom String
ThirdPartyClientId String
StatusId Integer

Status.Id

TicketTypeId Integer

TicketType.Id

SLAId Integer
PriorityId Integer
Source Integer
Impact Integer
Urgency Integer
EndUserStatus Integer
ParentStatus Integer
Category1 String
Category2 String
Category3 String
Category4 String
ItilRequestTypeId Integer
ServiceId Integer
AssetType Integer
AssetNumber Integer
AssetSite Integer
AssetString String
AssetKeyFieldString String
AssetTypeName String
InventoryNumber String
ChildTicketIdString String
ChangeState String
UnapprovedChangeStatus Integer
ChangeSeq Integer
MatchedKbId Integer

KBArticles.Id

MatchedRuleId Integer
MatchedRuleName String
TemplateId Integer
ChildTemplateId Integer
MailboxId Integer
MergedIntoId Integer
ContractId Integer

Contracts.Id

ContractRef String
ContractRefExtra String
ThirdPartyId Integer
ThirdPartyIdString String
ChatId Integer
ActionCode Integer
HdId Integer
CreatedFromId Integer
OperationalServiceId Integer
BudgetTypeId Integer
Currency Integer
MailEntryId String
SlaActionDate Datetime
SlaTimeElapsed Integer
SlaTimeLeft Integer
SlaPercentUsed Integer
SlaResponseState String
SlaState String
SlaExcuse String
SlaHoldTime Integer
SiteSlaId Integer
RespondByDate Datetime
ResponseDate Datetime
ResponseStartDate Datetime
ResponseTime Integer
FixByDate Datetime
SiteTimezone String
SectionTimezone String
TimezoneName String
DateOccurred Datetime
DateCreated Datetime
DateClosed Datetime
DateAssigned Datetime
LastActionDate Datetime
NextActivityDate Datetime
StartDate Datetime
StartTime String
StartTimeSlot Integer
TargetDate Datetime
TargetTime String
TargetTimeSlot Integer
DeadlineDate Datetime
FollowUpDate Datetime
PlannedDate Datetime
PlannedDateEnd Datetime
WorkflowStepStarted Datetime
LastRecurringEmailSentDate Datetime
SlaHoldReminderDateLastEmailed Datetime
LastBugzillaSync Datetime
AuditDate Datetime
AuditFailedDate Datetime
InvoiceDate Datetime
InvoicePaidDate Datetime
Estimate Integer
EstimateDays Integer
TimeTaken Integer
NonBillableTime Integer
Mileage Integer
ClosureTime Integer
WorkflowId Integer
WorkflowStep Integer
ApprovalStatus Integer
ApprovalProcessStep Integer
ApprovalProcessId Integer
ApprovedBy Integer

Agents.Id

NewApprovalProcess Integer
NewApprovalProcessAgentId Integer
NewApprovalProcessUserId Integer
NewApprovalProcessEmail String
NewApprovalProcessCabId Integer
UserRequestedApprover Integer
OppContactName String
OppCompanyName String
OppEmailAddress String
OppCustomerTitle String
OppTel String
OppAddress1 String
OppAddress2 String
OppAddress3 String
OppAddress4 String
OppPostcode String
OppCountry String
OppType String
OppValue Integer
OppConversionProbability Integer
OppValueAdjusted Integer
OppProfit Integer
OppCurrentSystem String
OppCompetitors String
OppAttemptsMade Integer
OppProductChosen String
OppReason String
OppHearAbout String
OppTimezoneName String
OppClosureCategory Integer
OppTrialDate Datetime
OppDemoDate Datetime
OppDiscountDate Datetime
OppConvertedDate Datetime
ReleaseId Integer
ReleaseName String
Release2Id Integer
Release2Name String
Release3Id Integer
Release3Name String
ReleaseNote String
ReleaseNoteGroupId Integer
ReleaseNoteGroupName String
SupplierId Integer

Suppliers.Id

SupplierName String
SupplierStatus Integer
SupplierReference String
SupplierSlaExcuse String
SupplierDate Datetime
SupplierContractId Integer
SupplierContractRef String
SupplierSlaId Integer
SupplierPriorityId Integer
SupplierResponseState String
SupplierResponseDate Datetime
SupplierResponseTime Integer
SupplierRespondByDate Datetime
SupplierSlaState String
SupplierSlaTimeElapsed Integer
SupplierDateClosed Datetime
SupplierFixByDate Datetime
InvoiceNumber String
InvoiceNote String
InvoiceStatus Integer
InvoiceDescription String
InvoiceLabourAmount Integer
InvoiceMaterialsAmount Integer
QuoteDescription String
QuoteLabourAmount Integer
QuotePriority Integer
QuoteMaterialsAmount Integer
QuotationCount Integer
BudgetCode Integer
ActualCost Integer
FirstTimeFix Integer
Justification String
BackoutPlan String
CommunicationPlan String
TestPlan String
RiskDescription String
RiskLevel Integer
ImpactDescription String
ImpactLevel Integer
LessonsLearned String
ClosureNote String
ClosureAgentId Integer

Agents.Id

ProjectTimeBudget Integer
ProjectMoneyBudget Integer
ProjectTimeActual Integer
ProjectMoneyActual Integer
ProjectConsignmentHeaderId Integer
ProjectConsignmentDetailId Integer
ProductId Integer
ProductName String
ProductKey String
ComponentId Integer
ComponentName String
VersionId Integer
VersionName String
UserDef1 String
UserDef2 String
UserDef3 String
UserDef4 String
UserDef5 String
ChildCount Integer
ChildCountOpen Integer
SiblingCountOpen Integer
AttachmentCount Integer
ChildActionCount Integer
UnreadChildActionCount Integer
FollowerCount Integer
AppointmentCount Integer
TaskCount Integer
ServiceCount Integer
CloneCount Integer
TodoCount Integer
ItemsIssuedCount Integer
ReassignCount Integer
AppointmentType Integer
SatisfactionLevel Integer
SatisfactionComment String
WhoResponded Integer
LastStatusChangeInformed Integer
LastStatusChangeInformedManager Integer
CausedBy Integer
FaultCodeOpen Integer
FaultCode Integer
LastStatus3rdParty Integer
CurrentFaActionNumber Integer
EmailPriority Integer
ChargeRate Integer
SendPrintRequest Integer
AuditStatus Integer
AuditUnum Integer
AuditNote String
AuditFailedNote String
ServiceFailurestId Integer
DeadlineNotificationHours Integer
TargetAdjust Integer
NewActionEmailFrom Integer
NewActionEmailFromAddressOverride String
EmailStartTagOverride String
EmailEndTagOverride String
AlertType String
GfiAlertType String
RoadmapNote String
MessageSent String
MessageSentLast String
LabNo String
SapId String
SapAttachmentsUuid String
SplunkUrl String
SplunkSearch String
PagerDutyId String
PagerDutyIncidentIdString String
PagerDutyStatus Integer
PagerDutyUrl String
PagerDutyIncidentId String
TwitterScreenName String
TwitterId Integer
FacebookUserId Integer
FacebookName String
FacebookId String
ImportId Integer
ImportType String
IsFlagged Boolean
IsRead Boolean
IsOnHold Boolean
IsVip Boolean
IsImportantContact Boolean
IsOpportunity Boolean
IsProject Boolean
IsExcludedFromSla Boolean
IsReleaseImportant Boolean
IsEverClosed Boolean
IsBeingClosed Boolean
IsCloseWithoutAgentAllowed Boolean
IsAgreedCleared Boolean
IsVisibleToUsers Boolean
IsSurveySent Boolean
IsSurveyNeeded Boolean
IsReviewed Boolean
IsKnownError Boolean
IsDevelopment Boolean
IsDeleted Boolean
IsShownOnRoadmap Boolean
IsAcknowledgementSendEnabled Boolean
IsActionBillableByDefault Boolean
IsInboundUpdatesForwarded Boolean
IsLoggedOutsideWorkingHours Boolean
IsAccountManagerSurveyInformed Boolean
IsUkasAccredited Boolean
IsThirdPartySystemNotified Boolean
IsRequestDetailsPrinted Boolean
IsServiceFormPrinted Boolean
IsArticleCreationEnabled Boolean
IsAutomationRulesSkipped Boolean
IsAutomationRulesApplied Boolean
IsChangeSeqUpdateSkipped Boolean
IsMatchedRuleNotificationSuppressed Boolean
IsKbMatchIgnored Boolean
IsFixByDateAdjusted Boolean
IsSupplierBreachResponseSent Boolean
IsSupplierBreachFixBySent Boolean
IsOppExcludedFromMailingList Boolean
IsTweet Boolean
IsFacebookPost Boolean
IsSentToPagerDuty Boolean
IsUpdateAllowed Boolean
IsSpam Boolean
IsSpamBlock Boolean
IsPreview Boolean
IsClientRefreshRequired Boolean
IsImport Boolean
IsReassignmentForced Boolean
IsAgent01CriteriaMet Boolean
IsAgent02CriteriaMet Boolean
IsIncludedInResponse Boolean
IsFormValidationEnabled Boolean
IsReclosed Boolean
ChildTicketIds String
User String
LastAction String
TicketType String
Outcomes String
NewApprovalProcessUsers String
NewApprovalProcessCab String
ApprovalProcess String
Approvers String
NewApprovers String
Appointments String
Qualifications String
Children String
Attachments String
PopupNotes String
Viewers String
Assets String
FollowersAgent String
FollowersUser String
ContactAddress String
BillingAddress String
DeliveryAddress String
TodoList String
Services String
Commits String
ItemsIssued String
Quotations String
Budgets String
Supplier String
NewServiceSubscribers String
CustomFields String

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9770.0