Documentation

Zuora

Suggest Edits

Zuora: Import Users & Subscription Activity

Zuora provides cloud-based software on a subscription basis that helps companies launch, manage, and transform into a subscription business. Enrich your user profiles in Lytics with user profile and subscription data from Zuora.

Integration Details

Steps/Pattern:

  1. Once a Zuora import job has been started, Lytics pulls contact and subscription information from the Zuora Data Query endpoint.
  2. If continuous import is selected, the job will run every four hours checking for contact and subscription updates since the last run.

Fields

The following fields are included in the default mapping of the zuora_contacts stream:

Source FieldLytics User FieldDescriptionType
Account.Idzuora_account_idZuora: Account IDstring
Account.Namezuora_account_nameZuora: Account Namestring
BillToContact.Address1zuora_bill_addressZuora: Bill Contact: Addressstring
BillToContact.Address2zuora_bill_address_2Zuora: Bill Contact: Address 2string
BillToContact.Cityzuora_bill_cityZuora: Bill Contact: Citystring
BillToContact.Countryzuora_bill_countryZuora: Bill Contact: Countrystring
BillToContact.FirstNamezuora_bill_first_nameZuora: Bill Contact: First Namestring
BillToContact.LastNamezuora_bill_last_nameZuora: Bill Contact: Last Namestring
BillToContact.PostalCodezuora_bill_postal_codeZuora: Bill Contact: Zipstring
BillToContact.Statezuora_bill_stateZuora: Bill Contact: Statestring
BillToContact.WorkPhonezuora_bill_work_phoneZuora: Bill Contact: Work Phonestring
SoldToContact.Address1zuora_sold_addressZuora: Sold Contact: Addressstring
SoldToContact.Address2zuora_sold_address_2Zuora: Sold Contact: Address 2string
SoldToContact.Cityzuora_sold_cityZuora: Sold Contact: Citystring
SoldToContact.Countryzuora_sold_countryZuora: Sold Contact: Countrystring
SoldToContact.FirstNamezuora_sold_first_nameZuora: Sold Contact: First Namestring
SoldToContact.LastNamezuora_sold_last_nameZuora: Sold Contact: Last Namestring
SoldToContact.PostalCodezuora_sold_postal_codeZuora: Sold Contact: Zipstring
SoldToContact.Statezuora_sold_stateZuora: Sold Contact: Statestring
SoldToContact.WorkPhonezuora_sold_work_phoneZuora: Sold Contact: Work Phonestring
email(oneof(SoldToContact.WorkEmail, SoldToContact.PersonalEmail, BillToContact.WorkEmail, BillToContact.PersonalEmail))email unique idstring
emaildomain(oneof(SoldToContact.WorkEmail, SoldToContact.PersonalEmail, BillToContact.WorkEmail, BillToContact.PersonalEmail))email_domainstring
hash.sha256(email(oneof(SoldToContact.WorkEmail, SoldToContact.PersonalEmail, BillToContact.WorkEmail, BillToContact.PersonalEmail)))email_sha256string
oneof(SoldToContact.Address1, BillToContact.Address1)address1string
oneof(SoldToContact.Address2, BillToContact.Address2)address2string
oneof(SoldToContact.City, BillToContact.City)citystring
oneof(SoldToContact.PostalCode, BillToContact.PostalCode)postal_codestring
oneof(SoldToContact.State, BillToContact.State)regionstring

The following fields are included in the default mapping of the zuora_activity stream:

Source FieldLytics User FieldDescriptionType
Invoice.Amountzuora_last_invoice_amountZuora: Last Invoice Amountnumber
Invoice.InvoiceNumberzuora_last_invoice_numberZuora: Last Invoice Numberstring
Invoice.PaymentAmountzuora_last_invoice_payment_amountZuora: Last Invoice Payment Amountnumber
Product.Descriptionzuora_product_descriptionZuora: Descriptionstring
Product.Namezuora_product_nameZuora: Product Namestring
email(BillToContact.WorkEmail)email unique idstring
emaildomain(BillToContact.WorkEmail)email_domainstring
hash.sha256(email(BillToContact.WorkEmail))email_sha256string
map(ProductRatePlan.Name, Subscription.AutoRenew)zuora_subscription_autorenewZuora: Subscription AutoRenewmap[string]string
map(ProductRatePlan.Name, Subscription.CancelledDate)zuora_subscription_cancelleddateZuora: Subscription CancelledDatemap[string]time
map(ProductRatePlan.Name, Subscription.CurrentTermPeriodType)zuora_subscription_currenttermperiodtypeZuora: Subscription CurrentTermPeriodTypemap[string]string
map(ProductRatePlan.Name, Subscription.InitialTermPeriodType)zuora_subscription_initialtermperiodtypeZuora: Subscription InitialTermPeriodTypemap[string]string
map(ProductRatePlan.Name, Subscription.RenewalTermPeriodType)zuora_subscription_renewaltermperiodtypeZuora: Subscription RenewalTermPeriodTypemap[string]string
map(ProductRatePlan.Name, Subscription.Status)zuora_subscription_statusZuora: Subscription Statusmap[string]string
map(ProductRatePlan.Name, Subscription.SubscriptionEndDate)zuora_subscription_end_dateZuora: Subscription End Datemap[string]time
map(ProductRatePlan.Name, Subscription.SubscriptionStartDate)zuora_subscription_start_dateZuora: Subscription Start Datemap[string]time
map(ProductRatePlan.Name, Subscription.TermType)zuora_subscription_termtypeZuora: Subscription TermTypemap[string]string
map(ProductRatePlan.Name, Subscription.Version)zuora_subscription_versionZuora: Subscription Versionmap[string]string
max(todate(Invoice.InvoiceDate))zuora_last_invoice_dateZuora: Last Invoicedate
set(Product.Id)product_idsProduct IDs[]string
set(Subscription.Name)zuora_subscriptionsZuora: Subscriptions[]string
sum(Invoice.Amount)zuora_last_invoice_total_amountZuora: Total Invoice Amountnumber
sum(Invoice.PaymentAmount)zuora_last_invoice_total_payment_amountZuora: Total Invoice Payment Amountnumber

Configuration

Follow these steps to set up and configure an import job for Zuora in the Lytics platform. If you are new to creating jobs in Lytics, see the Jobs Dashboard documentation for more information.

  1. Select Zuora from the list of providers.

  2. Select the import job type from the list.

  3. Select the Authorization you would like to use or create a new one.

  4. Enter a Label to identify this job you are creating in Lytics.

  5. (Optional) Enter a Description for further context on your job.

  6. (optional) Select the Keep Updated checkbox, to import list every day.

  7. Click the Complete button to start the job.

Updated 3 months ago