API Data Provider - Online Help

Clients

Client organisations managed in HaloServiceDesk, representing companies or accounts raising support tickets.

Columns

Name Type References
Id [KEY] Integer
Name String
TradingName String
Colour String
Logo String
Website String
Reference String
Use String
ClientKey Integer
TableType Integer
ImageIndex Integer
TopLevelId Integer

Clients.Id

TopLevelName String
MainSiteId Integer

Sites.Id

MainSiteName String
LinkedOrganisationId Integer
IsAllOrganisationsAllowed Boolean
DefaultOrganisationId Integer
PrimaryTechId Integer

Agents.Id

SecondaryTechId Integer

Agents.Id

AccountManagerTechId Integer

Agents.Id

IsPrimaryTechNotified Boolean
IsSecondaryTechNotified Boolean
IsPrimaryTechAutoAssigned Boolean
IsSecondaryTechAutoAssigned Boolean
MessageGroupId Integer
MailboxOverrideId Integer
DefaultMailboxId Integer
InvoiceMailboxOverrideId Integer
QuoteMailboxOverrideId Integer
AutomaticCallScriptId Integer
OverrideLayoutId Integer
CustomerType Integer
IsStopped Boolean
BillingGroup Integer
PreferredDeliveryMethod Integer
IsInactive Boolean
IsVip Boolean
IsAccount Boolean
IsTaxable Boolean
IsLocked Boolean
IsNhServerEmailDefault Boolean
IsSlaShownOnWeb Boolean
IsActionsIncluded Boolean
IsAllTicketTypesAllowed Boolean
IsAllCategory1Allowed Boolean
IsAllCategory2Allowed Boolean
IsAllCategory3Allowed Boolean
IsAllCategory4Allowed Boolean
IsAllChargeRatesAllowed Boolean
IsExcludedFromInvoiceSync Boolean
IsTicketInvoicesPerSite Boolean
IsInvoiceRequired Boolean
IsInvoicingDisabled Boolean
IsInvoicingEnabled Boolean
IsInvoiceEmailed Boolean
IsAutoInvoiceSendDisabled Boolean
IsRecurringPrepayBilled Boolean
IsExcludedFromAutoInvoiceReminders Boolean
SendAutomatedInvoiceRemindersAfterDays Integer
IsIncludedInMonthlyReport Boolean
IsMonthlyReportEmailedDirect Boolean
IsMonthlyReportEmailedToManager Boolean
IsMonthlyReportShownOnWeb Boolean
IsOrgLogoOverridden Boolean
IsPortalColourOverridden Boolean
IsFieldOverrideEnabled Boolean
IsUserDef1Hidden Boolean
IsUserDef2Hidden Boolean
IsUserDef3Hidden Boolean
IsUserDef4Hidden Boolean
IsUserDef5Hidden Boolean
IsUserDef1Mandatory Boolean
IsUserDef2Mandatory Boolean
IsUserDef3Mandatory Boolean
IsUserDef4Mandatory Boolean
IsUserDef5Mandatory Boolean
IsDefaultTeamFromSalesRepOverridden Boolean
IsHubSpotSyncDisabled Boolean
IsHubSpotArchived Boolean
IsArchivedXero Boolean
IsPrepayMinDeductionActiveContractsOnly Boolean
IsThirdPartyNhdValidated Boolean
ConfirmEmail Integer
ActionEmail Integer
ClearEmail Integer
FcEmail Integer
PercentageToSurvey Integer
DateCreated Datetime
LastUpdated Datetime
CallDate Datetime
CreatedFromId Integer
DefaultCategory1 String
DefaultCategory2 String
DefaultCategory3 String
DefaultCategory4 String
OverrideOrgName String
OverrideOrgPhone String
OverrideOrgEmail String
OverrideOrgWebsite String
OverrideOrgPortalUrl String
PortalColour String
PortalBackgroundImageUrl String
PortalChatProfile String
AccountsFirstName String
AccountsLastName String
AccountsBccEmailAddress String
ContractAccountsDescription String
PrepayAccountsDescription String
ItemTaxCode Integer
ServiceTaxCode Integer
PrepayTaxCode Integer
ContractTaxCode Integer
PurchaseTaxCode Integer
DefaultCurrencyCode Integer
ClientCurrency String
ClientToInvoiceId Integer

Clients.Id

ClientToInvoiceName String
ClientToInvoiceSiteName String
ClientToInvoiceRecurringId Integer

Clients.Id

ClientToInvoiceRecurringName String
ClientToInvoiceRecurringSiteName String
InvoiceDueDaysExtraClient Integer
OverridePdfTemplateInvoiceId Integer
OverridePdfTemplateQuoteId Integer
PrepayRecurringMinimumDeduction Decimal
PrepayRecurringAutomaticDeduction Decimal
QboDefaultTax Integer
QboDefaultTaxCode Integer
QboDefaultTaxCodeName String
QuickbooksTaxExemptionReasonId Integer
AvalaraTenant Integer
KashflowTenantId Integer
KashFlowId Integer
XeroId String
XeroTenantId String
AccountsId String
ITGlueId String
GfiClientId String
DbcCompanyId String
SnelStartId String
ConnectWiseAutomateId Integer
ConnectWiseId Integer
AutotaskId Integer
AteraId Integer
NinjaRmmId Integer
Device42Id Integer
SyncroId Integer
KaseyaId String
DattoId String
DattoAlternateId Integer
DattoUrl String
DattoCommerceId Integer
DattoCommerceUrl String
ThirdPartyNhdApiUrl String
ThirdPartyNhdAuthUrl String
ThirdPartyNhdTenant String
ThirdPartyNhdApiClientId String
SentinelSubscriptionId String
SentinelWorkspaceName String
SentinelResourceGroupName String
SentinelTenantId Integer
SentinelDefaultUserOverride Integer
ServiceNowId String
ServiceNowUrl String
ServiceNowLocale String
ServiceNowUsername String
ServiceNowTicketSync String
SyncServiceNowAttachments Integer
JiraUrl String
JiraUsername String
JiraStatusAfterUpdate Integer
JiraWebhookAuthentication Integer
CustomerRelationship String
CustomerRelationshipList String
AllowedTicketTypes String
ExternalLinks String
Notes String
CustomFields String
CustomButtons String

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