Skip to content

Export Customers from HaloPSA

This task will allow you to export customer data from your HaloPSA platform based on the task settings provided.

Settings

Connection

Required
The HaloPSA connection to use. See Connecting to HaloPSA.

File Settings

Output File

The data exported from this task will be saved to an XML in the given location.

HaloPSA Settings

Export Date

When using the Modified or New Export Type options, this date will appended to the request to return records updated or created after this date.

Furthermore, this date will be automatically updated to the date of the most recently exported record on a successful execution.

The setting will be ignored when the All Export Type option is selected.

Export Type

This setting indicates the array of data you'd like to return, e.g if you want to export only modified records, select the Modified option.

  • New
  • Modified
  • All

Page Size

The amount of records to return per page from the HaloPSA API.

Export Account Manager

Set to true to export the corresponding account manager for each customer record.

Export Customer Addresseses

Set to true to export the corresponding addresses for each customer record.

Export Customer Address Contact

Set to true to export the corresponding contact for each address on each customer record.

Export Customer Address Country Code

Set to true to export the corresponding country code for each address on each customer record.

Zynk Settings

See Common Task Settings

Examples

Sample output file:

<?xml version="1.0" encoding="utf-8"?>
<Customers xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Customer>
    <Id>12</Id>
    <Errors />
    <TopLevelId>1</TopLevelId>
    <TopLevelName>Areas</TopLevelName>
    <CreatedDate>2019-01-09T09:37:08.62</CreatedDate>
    <ModifiedDate>2023-07-06T21:28:58.083</ModifiedDate>
    <CustomFields>
      <CustomField Id="202" Name="CFCustomerType" Label="Customer Type">
        <Type>2</Type>
        <InputType>0</InputType>
        <ExtraType>1</ExtraType>
        <ShouldDisplay>Converted</ShouldDisplay>
        <CharacterLimit>0</CharacterLimit>
        <CharacterLimitType>0</CharacterLimitType>
        <ShouldCopyToChild>false</ShouldCopyToChild>
        <ShouldCopyToChildOnUpdate>false</ShouldCopyToChildOnUpdate>
        <ShouldCopyToRelated>false</ShouldCopyToRelated>
        <IsSearchable>false</IsSearchable>
        <ShouldOrderValues>true</ShouldOrderValues>
        <OrderValuesBy>1</OrderValuesBy>
        <ShouldLookupDatabaseInfo>false</ShouldLookupDatabaseInfo>
        <Usage>2</Usage>
        <ShouldShowOnDetails xsi:nil="true" />
        <CustomTableId>0</CustomTableId>
        <Calculation />
        <Regex />
        <IsHorizontal>false</IsHorizontal>
        <IsEncrypted>false</IsEncrypted>
        <SelectionFieldId>0</SelectionFieldId>
        <Value>2</Value>
      </CustomField>
      <CustomField Id="204" Name="CFContactPreferences" Label="Contact Preferences">
        <Type>3</Type>
        <InputType>0</InputType>
        <ExtraType>1</ExtraType>
        <ShouldDisplay>Email, Telephone</ShouldDisplay>
        <CharacterLimit>0</CharacterLimit>
        <CharacterLimitType>0</CharacterLimitType>
        <ShouldCopyToChild>false</ShouldCopyToChild>
        <ShouldCopyToChildOnUpdate>false</ShouldCopyToChildOnUpdate>
        <ShouldCopyToRelated>false</ShouldCopyToRelated>
        <IsSearchable>false</IsSearchable>
        <ShouldOrderValues>true</ShouldOrderValues>
        <OrderValuesBy>1</OrderValuesBy>
        <ShouldLookupDatabaseInfo>false</ShouldLookupDatabaseInfo>
        <Usage>2</Usage>
        <ShouldShowOnDetails xsi:nil="true" />
        <CustomTableId>0</CustomTableId>
        <Calculation />
        <Regex />
        <IsHorizontal>false</IsHorizontal>
        <IsEncrypted>false</IsEncrypted>
        <SelectionFieldId>0</SelectionFieldId>
        <Value>
          <Items>
            <Item Id="1">Email</Item>
            <Item Id="2">Telephone</Item>
          </Items>
        </Value>
      </CustomField>
    </CustomFields>
    <Name>Zynk Software Ltd</Name>
    <IsInactive>false</IsInactive>
    <Colour>#e83c4a</Colour>
    <ConfirmEmail>1</ConfirmEmail>
    <ActionEmail>1</ActionEmail>
    <ClearEmail>1</ClearEmail>
    <MessageGroupId>-1</MessageGroupId>
    <OverrideOrganisationLogo>false</OverrideOrganisationLogo>
    <OverrideOrganisationName />
    <OverrideOrgTelephone />
    <OverrideOrganisationEmail />
    <OverrideOrganisationWebsite />
    <OverrideOrgPortalUrl />
    <ShouldOverrideMailbox>-1</ShouldOverrideMailbox>
    <DefaultMailboxId>0</DefaultMailboxId>
    <CallDate>2023-08-18T15:25:00</CallDate>
    <ItemTaxCode>1</ItemTaxCode>
    <ServiceTaxCode>1</ServiceTaxCode>
    <PrepayTaxCode>1</PrepayTaxCode>
    <ContractTaxCode>1</ContractTaxCode>
    <Custombuttons />
    <PrimaryTechnician xsi:nil="true" />
    <SecondaryTechnician xsi:nil="true" />
    <AccountManagerTechnician>3</AccountManagerTechnician>
    <ThirdPartyApiUrl />
    <XeroId />
    <CreatedFromId>0</CreatedFromId>
    <PrimaryNotification>false</PrimaryNotification>
    <SecondaryNotification>false</SecondaryNotification>
    <PrimaryAssignee>false</PrimaryAssignee>
    <ScondaryAssignee>false</ScondaryAssignee>
    <ChargePeriod xsi:nil="true" />
    <PrimaryHoursToCharge xsi:nil="true" />
    <SecondaryHoursToCharge xsi:nil="true" />
    <CarryOverCharge xsi:nil="true" />
    <ShouldInvoice>false</ShouldInvoice>
    <FlOverride>false</FlOverride>
    <FlUserDefinition1Hide>false</FlUserDefinition1Hide>
    <FlUserDefinition2Hide>false</FlUserDefinition2Hide>
    <FlUserDefinition3Hide>false</FlUserDefinition3Hide>
    <FlUserDefinition4Hide>false</FlUserDefinition4Hide>
    <FlUserDefinition5Hide>false</FlUserDefinition5Hide>
    <FlUserDefinition1Mandatory>false</FlUserDefinition1Mandatory>
    <FlUserDefinition2Mandatory>false</FlUserDefinition2Mandatory>
    <FlUserDefinition3Mandatory>false</FlUserDefinition3Mandatory>
    <FlUserDefinition4Mandatory>false</FlUserDefinition4Mandatory>
    <FlUserDefinition5Mandatory>false</FlUserDefinition5Mandatory>
    <ShouldIncludeActions>false</ShouldIncludeActions>
    <StartDate xsi:nil="true" />
    <StartBalance xsi:nil="true" />
    <PrimaryHourlyRate xsi:nil="true" />
    <SecondaryHourlyRate xsi:nil="true" />
    <ShouldNotInvoice>false</ShouldNotInvoice>
    <ShouldShowSla>false</ShouldShowSla>
    <ImageIndex>3</ImageIndex>
    <Enddate xsi:nil="true" />
    <UcEmail xsi:nil="true" />
    <FcEmail>1</FcEmail>
    <SmsBalance xsi:nil="true" />
    <Hv xsi:nil="true" />
    <HvDate xsi:nil="true" />
    <ShouldEmailInvoice>false</ShouldEmailInvoice>
    <ShouldNotSendInvoices>false</ShouldNotSendInvoices>
    <SeriousnessLevel xsi:nil="true" />
    <DefinedCategory1 />
    <DefinedCategory2 />
    <DefinedCategory3 />
    <DefinedCategory4 />
    <IsThresholdBreached xsi:nil="true" />
    <ShouldIncludeMonthlyReport>false</ShouldIncludeMonthlyReport>
    <ShouldEmailMonthlyReportDirect>false</ShouldEmailMonthlyReportDirect>
    <ShouldEmailMonthlyReportToManager>false</ShouldEmailMonthlyReportToManager>
    <ShowMonthlyReports>false</ShowMonthlyReports>
    <AreaTypeId xsi:nil="true" />
    <UnmatchedCombinations xsi:nil="true" />
    <NextPrepayRecurringChargeDate xsi:nil="true" />
    <ShouldBillForRecurringPrepayAmount>false</ShouldBillForRecurringPrepayAmount>
    <RecurringPrepayCharge xsi:nil="true" />
    <RecurringPrepayHours xsi:nil="true" />
    <RecurringPrepayChargeBp xsi:nil="true" />
    <ShouldShowNonBillable xsi:nil="true" />
    <BillingGroup>0</BillingGroup>
    <AutoTopUpThreshhold xsi:nil="true" />
    <AutoTopUpAmount xsi:nil="true" />
    <AutoTopUpHourlyCost xsi:nil="true" />
    <AutoTopUpByAmount xsi:nil="true" />
    <SurchargeId xsi:nil="true" />
    <BillingTemplateId xsi:nil="true" />
    <ClientPackageId xsi:nil="true" />
    <ScopeOfBusinessId xsi:nil="true" />
    <PreferredAgentId xsi:nil="true" />
    <DiscountPercentage xsi:nil="true" />
    <ShouldShowFaqForTopLevel xsi:nil="true" />
    <IsOpportunity xsi:nil="true" />
    <MainSiteId>18</MainSiteId>
    <MainSiteName>Main</MainSiteName>
    <LinkedOrganisationId>1</LinkedOrganisationId>
    <ShouldAllOrganisationsBeAllowed>true</ShouldAllOrganisationsBeAllowed>
    <ContractAccountsDescription />
    <PrepayAccountsDescription />
    <PopUpNote />
    <ShouldAllowAllTicketTypes>true</ShouldAllowAllTicketTypes>
    <AllowedTicketTypes />
    <ShouldAllowAllCategory1>true</ShouldAllowAllCategory1>
    <ShouldAllowAllCategory2>true</ShouldAllowAllCategory2>
    <ShouldAllowAllCategory3>true</ShouldAllowAllCategory3>
    <ShouldAllowAllCategory4>true</ShouldAllowAllCategory4>
    <IsLocked>false</IsLocked>
    <ShouldAllowAllChargeRates>true</ShouldAllowAllChargeRates>
    <ShouldExcludeInvoiceSync>false</ShouldExcludeInvoiceSync>
    <ThirdPartyAuthorisationUrl />
    <ThirdPartyTenant />
    <ThirdPartyApiClientId />
    <OverridePortalColour>false</OverridePortalColour>
    <PortalColour />
    <PortalBackgroundImageUrl />
    <NinjaRmmId>0</NinjaRmmId>
    <IsArchivedInXero>false</IsArchivedInXero>
    <AccountsForename />
    <AccountsSurname />
    <PurchaseTaxCode>0</PurchaseTaxCode>
    <RecurringPrepayMinimumDeduction>0</RecurringPrepayMinimumDeduction>
    <IsRecurringPrepayMinimumDeductionActive>false</IsRecurringPrepayMinimumDeductionActive>
    <RecurringPrepayAutomaticDeduction>0</RecurringPrepayAutomaticDeduction>
    <DeliveryMethodId>0</DeliveryMethodId>
    <QboDefaultTaxId>0</QboDefaultTaxId>
    <Device42Id>0</Device42Id>
    <ServiceNowId />
    <IsNhServerEmailDefault>false</IsNhServerEmailDefault>
    <DattoId />
    <DattoAlternateId>0</DattoAlternateId>
    <DattoUrl />
    <QboDefaultTaxCode>0</QboDefaultTaxCode>
    <QboDefaultTaxCodeName />
    <ConnectWiseId>0</ConnectWiseId>
    <AutoTaskId>-1</AutoTaskId>
    <AteraId>0</AteraId>
    <KashflowId>0</KashflowId>
    <Website />
    <SnelStartId />
    <DattoCommerceId>-1</DattoCommerceId>
    <SyncroidId>0</SyncroidId>
    <ShouldNotSyncToHubspot>false</ShouldNotSyncToHubspot>
    <IsArchivedInHubspot>false</IsArchivedInHubspot>
    <AccountsBccEmail />
    <ShouldDefaultTeamToSalesRepOverride>false</ShouldDefaultTeamToSalesRepOverride>
    <PortalChatProfileName />
    <KaseyaId />
    <TradingName>HaloPSA Test</TradingName>
    <ServiceNowUrl />
    <ServiceNowLocale />
    <ServicenNwUsername />
    <JiraUrl />
    <JiraUsername />
    <Use>client</Use>
    <Logo>https://zynksoftwareltd.halopsa.com/api/attachment/image/58D3D4D6-619D-4FE4-8A35-6616713DBAA6</Logo>
    <XeroTenantId />
    <ShouldOverrideInvoicePdftemplate>-1</ShouldOverrideInvoicePdftemplate>
    <KashflowTenantId>0</KashflowTenantId>
    <ClientToInvoice>0</ClientToInvoice>
    <ClientToInvoiceName />
    <ExtraDueDays>0</ExtraDueDays>
    <ItGlueId />
    <ClientCurrency />
    <SentinelSubscriptionId />
    <SentinelWorkspaceName />
    <SentinelResourceGroupName />
    <DefaultCurrencyCode>0</DefaultCurrencyCode>
    <ClientToInvoiceRecurring>0</ClientToInvoiceRecurring>
    <ClientToInvoiceRecurringName />
    <Cautomateid>0</Cautomateid>
    <DbcCompanyId />
    <Stopped xsi:nil="true" />
    <CustomerType xsi:nil="true" />
    <SentinelDefaultUserOverride>0</SentinelDefaultUserOverride>
    <TicketInvoicesForEachSite>false</TicketInvoicesForEachSite>
    <IsVip>false</IsVip>
    <Taxable>false</Taxable>
    <PercentageToSurvey>0</PercentageToSurvey>
  </Customer>
</Customers>