Import Customers into HaloPSA
This task will allow you to import customer data into your HaloPSA platform based on the task settings and XML data provided.
Settings
Connection
Required
The HaloPSA connection to use. See Connecting to HaloPSA.
File Settings
Fail File
Required
The XML file to save failed records to. The XML format will be the same as the input file.
Input File
Required
The XML file containing records to import into HaloPSA. An example of the XML format is shown below.
Success File
Required
The XML file to save successful records to. The XML format will be the same as the input file.
Import Settings
Prevent Reprocessing
Required
Set to true to prevent the same records being processed more than once, based on the value of the <ExternalId> element in the XML.
Zynk Settings
Examples
Sample input 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>1</Id>
<TopLevelId>1</TopLevelId>
<TopLevelName>Areas</TopLevelName>
<CreatedDate>2019-01-09T09:37:08.62</CreatedDate>
<ModifiedDate>2023-10-19T13:54:37.61</ModifiedDate>
<CustomFields>
<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>Unknown</Name>
<IsInactive>false</IsInactive>
<Colour>#E27300</Colour>
<ConfirmEmail>0</ConfirmEmail>
<ActionEmail>0</ActionEmail>
<ClearEmail>0</ClearEmail>
<MessageGroupId>0</MessageGroupId>
<OverrideOrganisationLogo>false</OverrideOrganisationLogo>
<OverrideOrganisationName />
<OverrideOrgTelephone />
<OverrideOrganisationEmail />
<OverrideOrganisationWebsite />
<OverrideOrgPortalUrl />
<OverideGreeting />
<ShouldOverrideMailbox>-1</ShouldOverrideMailbox>
<DefaultMailboxId>0</DefaultMailboxId>
<CallDate>1900-01-01T00:00:00</CallDate>
<ItemTaxCode>1</ItemTaxCode>
<ServiceTaxCode>1</ServiceTaxCode>
<PrepayTaxCode>1</PrepayTaxCode>
<ContractTaxCode>1</ContractTaxCode>
<Custombuttons />
<PrimaryTechnician>0</PrimaryTechnician>
<SecondaryTechnician>0</SecondaryTechnician>
<AccountManagerTechnician>2</AccountManagerTechnician>
<ThirdPartyApiUrl />
<XeroId />
<CreatedFromId>0</CreatedFromId>
<PrimaryNotification>false</PrimaryNotification>
<SecondaryNotification>false</SecondaryNotification>
<PrimaryAssignee>false</PrimaryAssignee>
<ScondaryAssignee>false</ScondaryAssignee>
<ChargePeriod>0</ChargePeriod>
<PrimaryHoursToCharge>0</PrimaryHoursToCharge>
<SecondaryHoursToCharge>0</SecondaryHoursToCharge>
<CarryOverCharge>0</CarryOverCharge>
<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>2011-01-28T00:00:00</StartDate>
<StartBalance>0</StartBalance>
<PrimaryHourlyRate>0</PrimaryHourlyRate>
<SecondaryHourlyRate>0</SecondaryHourlyRate>
<ShouldNotInvoice>false</ShouldNotInvoice>
<ShouldShowSla>false</ShouldShowSla>
<ImageIndex>2</ImageIndex>
<Enddate>1899-12-30T00:00:00</Enddate>
<UcEmail>0</UcEmail>
<FcEmail>0</FcEmail>
<SmsBalance>0</SmsBalance>
<Hv>0</Hv>
<HvDate>1899-12-30T00:00:00</HvDate>
<ShouldEmailInvoice>true</ShouldEmailInvoice>
<ShouldNotSendInvoices>false</ShouldNotSendInvoices>
<SeriousnessLevel>-1</SeriousnessLevel>
<DefinedCategory1 />
<DefinedCategory2 />
<DefinedCategory3 />
<DefinedCategory4 />
<IsThresholdBreached>0</IsThresholdBreached>
<ShouldIncludeMonthlyReport>false</ShouldIncludeMonthlyReport>
<ShouldEmailMonthlyReportDirect>false</ShouldEmailMonthlyReportDirect>
<ShouldEmailMonthlyReportToManager>false</ShouldEmailMonthlyReportToManager>
<ShowMonthlyReports>false</ShowMonthlyReports>
<AreaTypeId>0</AreaTypeId>
<UnmatchedCombinations>1</UnmatchedCombinations>
<NextPrepayRecurringChargeDate>1899-12-30T00:00:00</NextPrepayRecurringChargeDate>
<ShouldBillForRecurringPrepayAmount>false</ShouldBillForRecurringPrepayAmount>
<RecurringPrepayCharge>0</RecurringPrepayCharge>
<RecurringPrepayHours>0</RecurringPrepayHours>
<RecurringPrepayChargeBp>-1</RecurringPrepayChargeBp>
<AccountsEmail />
<Disclaimer />
<ShouldShowNonBillable>false</ShouldShowNonBillable>
<BillingGroup>0</BillingGroup>
<AutoTopUpThreshhold>0</AutoTopUpThreshhold>
<AutoTopUpAmount>0</AutoTopUpAmount>
<AutoTopUpHourlyCost>0</AutoTopUpHourlyCost>
<AutoTopUpByAmount>0</AutoTopUpByAmount>
<SurchargeId>0</SurchargeId>
<BillingTemplateId>0</BillingTemplateId>
<ClientPackageId>-1</ClientPackageId>
<ScopeOfBusinessId>-1</ScopeOfBusinessId>
<PreferredAgentId>0</PreferredAgentId>
<CallHandlingNotes />
<DiscountPercentage>0</DiscountPercentage>
<ShouldShowFaqForTopLevel>false</ShouldShowFaqForTopLevel>
<AccountsCcEmail />
<IsOpportunity>0</IsOpportunity>
<SnowName />
<MainSiteId>1</MainSiteId>
<MainSiteName>Unknown</MainSiteName>
<LinkedOrganisationId>0</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>Unknown</TradingName>
<ServiceNowUrl />
<ServiceNowLocale />
<ServicenNwUsername />
<JiraUrl />
<JiraUsername />
<Use>client</Use>
<Logo>https://zynksoftwareltd.halopsa.com/api/attachment/image/A41B0DA2-02F9-41DD-814A-3D5C42BD2BC6</Logo>
<XeroTenantId />
<Accountsid />
<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>0</Stopped>
<CustomerType>0</CustomerType>
<SentinelDefaultUserOverride>0</SentinelDefaultUserOverride>
<TicketInvoicesForEachSite>false</TicketInvoicesForEachSite>
<IsVip>false</IsVip>
<Taxable>false</Taxable>
<PercentageToSurvey>0</PercentageToSurvey>
</Customer>
</Customers>