Skip to main content Skip to complementary content

Zuora 

Zuora is a software for subscription revenue management automation. You can connect to Zuora to land data as a data source when landing or replicating data with Data Gateway - Data Movement.

For more information about the API, see REST API and AQuA API.

See the Schema section for a list of objects available for replication.

Preparing for authentication

To access your data, you need to authenticate the connection with your account credentials.

Information noteMake sure that the account you use has read access to the tables you want to fetch.

To set up Zuora, you need a Zuora user. Creating a-specific user ensures that Qlik is distinguishable in any logs or audits

To replicate your Zuora data, you need:

  • Standard user permissions. While Qlik will only ever read your data, these permissions are required to access certain objects in Zuora.
  • Two-factor authentication disabled. If this is enabled, connection and replication issues will occur after setup. See the Disable or Reset Two-Factor Authentication sections in Zuora documentation.
  • Credentials that don’t expire. This is applicable only if your company enforces password expiration rules. If Zuora credentials expire, connection issues may arise. See this Zuora support article for a workaround.
  1. Log into your Zuora account as the tenant administrator.
  2. Click your username in the top-right corner > Administration > Manage User Roles.
  3. Click Add new role.
  4. Enter a first and last name for the user.
  5. Enter an email address in the Work Email and Login Field fields.
  6. In the Zuora Platform Role field, select Standard User.
  7. For the remaining Role fields, select the Standard User option.
  8. Leave Locale and Language fields as default .
  9. Click Save to create the user.

After the user is created, Zuora sends a verification email to the email address in the Work Email field. Complete the verification and set a password for the user before moving on to the next step.

Selecting a Zuora extraction API

Zuora integration gives you the ability to select the API that you want to use to extract data. If you are not sure which API you should use, take a look at the brief comparison below.

This setting can be changed at any time, but will only affect extractions that take place after the change.

Once you have decided, click the radio button next to the API you want to use.

Information note When using the AQuA API, you will need to enter a partner ID in the Zuora Partner ID field. If you do not already have this credential, reach out to Zuora Global Support before proceeding.

 REST APIAQuA API
Good for replicating Small datasets, more frequently Large datasets, less frequently

Deleted records

Unsupported

Supported.

An additional column (deleted) will be added to objects that support deletions, which indicates the record’s deletion status.

Deleted data extraction is unsupported by the AQuA API for the following objects:

  • accountingPeriod
  • contactSnapshot
  • discountAppliedMetrics
  • paymentGaterwayReconciliationEventLog
  • paymentTransactionLog
  • paymentMethodTransactionLog
  • paymentReconciliationJob
  • paymentReconciliationLog
  • processedUsage
  • refundTransactionLog
  • updaterBatch
  • updaterDetail

See Zuora’s documentation for more info.

Requires additional Zuora credentials Not required

Required.

Using the AQuA API requires a Partner ID - to obtain one, reach out to Zuora Global Support.

Creating the connection

For more information, see Connecting to SaaS applications.

  1. Fill in the required connection properties.
  2. Provide a name for the connection in Connection name.

  3. Select Open connection metadata to define metadata for the connection when it has been created.

  4. Click Create.

Connection settings
SettingDescription
Data gateway

Select a Data Movement gateway if required by your use case.

Information note

This field is not available with the Qlik Talend Cloud Starter subscription, as it does not support Data Movement gateway. If you have another subscription tier and do not want to use Data Movement gateway, select None.

For information on the benefits of Data Movement gateway and use cases that require it, see Qlik Data Gateway - Data Movement.

Start Date

Enter the date, in the format MM/DD/YYYY, from which the data must be replicated from your source to your target.

Zuora usernameZuora username.
Zuora passwordZuora password.
Connect to a sandbox environmentIf the Zuora instance to whiçh you want to connect is a sandbox, select the checkbox.
Connect to a European endpointIf the Zuora instance to which you want to connect is based in Europe, select the check box. If you are not sure if this is applicable to you, refer to Zuora’s documentation.
API TypeSelect the type from the drop-down list.

The AQuA API is Zuora's API. It supports retrieving deleted data and exporting data in segments, which is useful for large amounts of data.

The REST API is recommended for smaller datasets and when deleted data is not important.

Zuora Partner IDZuora partner ID.

Schema

Information note

Schemas and naming conventions can change from version to version. It is recommended to verify your version before continuing.

The schema and info displayed below is for version 1.

Zuora object relationships

To get a better understanding of how Zuora objects relate to each other, check out Zuora’s Entity Relationship Diagram.

Understanding the relationships between different datasets lets you perform more in-depth and complex analyses.

Depending on your destination, table and column names may not appear as they are outlined below.

Account

The Account table contains information about the customer accounts in your Zuora instance.

Replication Method

CDC

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

AccountingCode

The AccountingCode table contains information about the accounting codes in your Zuora instance. Accounting codes are used to categorize transactions for accounting purposes.

Note: To replicate this table, you must have Zuora Finance enabled.

Replication Method

CDC

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

AccountingPeriod

The AccountingPeriod table contains information about the accounting periods in your Zuora account.

Note: To replicate this table, you must have Zuora Finance enabled.

Replication Method

CDC

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

Amendment

The Amendment table contains information about subscription amendments, which are changes to customer subscriptions. For example: Changing the terms of a contract, adding/removing a product, canceling a subscription, etc.

Replication Method

CDC

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

BillingRun

The BillingRun table contains information about billing runs.

Replication Method

CDC

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

CommunicationProfile

The CommunicationProfile table contains information about communication profiles, which are sets of policies that determine how to communicate with the contacts associated with a specific customer account.

Replication Method

CDC

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

Contact

The Contact table contains info about an account’s point-of-contact.

Replication Method

CDC

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

ContactSnapshot

The ContactSnapshot table contains ‘snapshot’ records of Bill-To or Sold-To contacts on customer accounts. Snapshots are record preservations at specific points in time. When invoices are posted, Zuora will preserve the data for the Bill-To and Sold-To contacts at that point in time.

Replication Method

CDC

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

CreditBalanceAdjustment

The CreditBalanceAdjustment table contains information about credit balance adjustments, or the application of credit balances to invoices, payments, and refunds.

Replication Method

CDC

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

DiscountAppliedMetrics

The DiscountAppliedMetrics table contains information about rate plan charges that use either a discount-fixed amount or discount-percentage charge model.

Replication Method

CDC

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

Export

The Export table contains information about export jobs and files.

Replication Method

CDC

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

Import

The Import table contains information about content uploads.

Replication Method

CDC

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

Invoice

The Invoice table contains info about invoices, which are bills to customers.

Replication Method

CDC

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

InvoiceItem

The InvoiceItem table contains info about the line items in invoices.

Replication Method

CDC

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

InvoiceItemAdjustment

The InvoiceItemAdjustment table contains info about adjustments applied to invoice line items.

Replication Method

CDC

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

JournalEntry

The JournalEntry table contains information about

Replication Method

CDC

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

JournalEntryItem

The JournalEntryItem table contains information about journal entry items.

Replication Method

CDC

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

JournalRun

The JournalRun table contains information about journal runs.

Replication Method

CDC

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

Payment

The payment table contains info about customer payments.

Replication Method

CDC

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

PaymentRun

The PaymentRun table contains information about payment runs.

Replication Method

CDC

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

ProcessedUsage

The ProcessedUsage table contains information about usage.

Replication Method

CDC

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

Product

The Product table contains info about your company’s product offerings.

Replication Method

CDC

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

ProductRatePlan

The ProductRatePlan table contains info about product rate plans, or the part of a product that customers can subscribe to.

Replication Method

CDC

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

ProductRatePlanCharge

The ProductRatePlanCharge table contains info about product rate plan charges, which are a charge model or set of fees associated with a product rate plan.

Replication Method

CDC

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

ProductRatePlanChargeTier

The ProductRatePlanChargeTier table contains pricing info for product rate plan charges.

Replication Method

CDC

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

RatePlan

The RatePlan table contains info about rate plans, which is a price or collection of prices for services.

Custom fields

In addition to the attributes listed below, our Zuora integration will also replicate any custom fields.

Replication Method

CDC

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

RatePlanChargeTier

The RatePlanChargeTier table contains pricing info for rate plan charges.

Replication Method

CDC

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

Refund

The Refund table contains info about refunds, or transactions where money is returned to a customer.

Replication Method

CDC

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

RevenueChargeSummaryItem

The RevenueChargeSummaryItem table contains information about charge revenue summaries, which are summaries of all revenue distributions associated with a subscription charge.

Replication Method

CDC

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

RevenueEventItem

The RevenueEventItem table contains information about revenue events. A revenue event is a change to a revenue schedule, such as creating the initial schedule, canceling an invoice, or recognizing an undistributed amount.

Replication Method

CDC

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

RevenueEventItemInvoiceItem

The RevenueEventItemInvoiceItem table contains information about revenue event items that are associated with invoice items.

Replication Method

CDC

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

RevenueEventItemInvoiceItemAdjustment

The RevenueEventItemInvoiceItemAdjustment table contains information about revenue event items that are associated with invoice item adjustments.

Replication Method

CDC

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

RevenueScheduleItem

The RevenueScheduleItem table contains information about revenue schedules. A revenue schedule represents how revenue amounts from single charges are distributed over time and recognized in accounting periods.

Replication Method

CDC

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

RevenueScheduleItemInvoiceItem

The RevenueScheduleItemInvoiceItem table contains information about revenue schedule item - invoice items.

Replication Method

CDC

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

RevenueScheduleItemInvoiceItemAdjustment

The RevenueScheduleItemInvoiceItemAdjustment table contains information about revenue schedule item - invoice items.

Replication Method

CDC

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

Subscription

The Subscription table contains info about your products and/or services with recurring charges.

Custom Attributes

If your Zuora subscription records contain custom attributes, they will be replicated.

Replication Method

CDC

Primary Key

id

Replication Key

updatedDate

Useful links

Zuora documentation

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!