Zuora

Sync overview

The Zuora source supports both Full Refresh and Incremental syncs. You can choose if this connector will copy only the new or updated data, or all rows in the tables and columns you set up for replication, every time a sync is run.
Airbyte uses REST API to fetch data from Zuora. The REST API accepts ZOQL (Zuora Object Query Language), a SQL-like language, to export the data.
This Source Connector is based on a Airbyte CDK.

Output schema

This Source is capable of syncing:
  • standard objects available in Zuora account
  • custom objects manually added by user, available in Zuora Account
  • custom fields in both standard and custom objects, available in Zuora Account
The discovering of Zuora Account objects schema may take a while, if you add the connection for the first time, and/or you need to refresh your list of available streams. Please take your time to wait and don't cancel this operation, usually it takes up to 5-10 min, depending on number of objects available in Zuora Account.

Note:

Some of the Zuora Objects may not be available for sync due to limitations of Zuora Supscription Plan, Permissions. For details refer to the Availability of Data Source Objects section in the Zuora documentation.

Data type mapping

Integration Type
Airbyte Type
Notes
decimal(22,9)
number
float number
decimal
number
float number
float
number
float number
double
number
float number
integer
number
int
number
bigint
number
smallint
number
timestamp
number
number representation of the unix timestamp
date
string
datetime
string
timestamp with time zone
string
picklist
string
text
string
varchar
string
zoql
object
binary
object
json
object
xml
object
blob
object
list
array
array
array
boolean
boolean
bool
boolean
Any other data type not listed in the table above will be treated as string.

Features

Feature
Supported?(Yes/No)
Notes
Full Refresh Overwrite Sync
Yes
Full Refresh Append Sync
Yes
Incremental - Append Sync
Yes
Incremental - Append + Deduplication Sync
Yes
Namespaces
No

Supported Environments for Zuora

Environment
Supported?(Yes/No)
Notes
Production
Yes
Select from exising options while setup
Sandbox
Yes
Select from exising options while setup

Supported Data Query options

Option
Supported?(Yes/No)
Notes
LIVE
Yes
Run data queries against Zuora live transactional databases
UNLIMITED
Yes
Run data queries against an optimized, replicated database at 12 hours freshness for high volume extraction use cases (Early Adoption, additionall access required, contact Zuora Support in order to request this feature enabled for your account beforehand.)

List of Supported Environments for Zuora

Production

Environment
Endpoint
US Production
rest.zuora.com
US Cloud Production
rest.na.zuora.com
EU Production
rest.eu.zuora.com

Sandbox

Environment
Endpoint
US API Sandbox
rest.apisandbox.zuora.com
US Cloud API Sandbox
rest.sandbox.na.zuora.com
US Central Sandbox
rest.test.zuora.com
EU API Sandbox
rest.sandbox.eu.zuora.com
EU Central Sandbox
rest.test.eu.zuora.com

Other

Environment
Endpoint
US Performance Test
rest.pt1.zuora.com
For more information about available environments, please visit this page

Performance considerations

If you experience the long time for sync operation, please consider:
  • to increase the window_in_days parameter inside Zuora source configuration
  • use the smaller date range by tuning start_date parameter.

Note

Usually, the very first sync operation for all of the objects inside Zuora account takes up to 25-45-60 min, the more data you have, the more time you'll need.

Getting started

Create an API user role

  1. 1.
    Log in to your Zuora acccount.
  2. 2.
    In the top right corner of the Zuora dashboard, select Settings > Administration Settings.
  3. 3.
    Select Manage User Roles.
  4. 4.
    Select Add new role to create a new role, and fill in neccessary information up to the form.

Assign the role to a user

  1. 1.
    From the administration page, click Manage Users.
  2. 2.
    Click add single user.
  3. 3.
    Create a user and assign it to the role you created in Create an API user role section.
  4. 4.
    You should receive an email with activation instructions. Follow them to activate your API user.
    For more information visit Create an API User page

Create Client ID and Client Secret

  1. 1.
    From the administration page, click Manage Users.
  2. 2.
    Click on User Name of the target user.
  3. 3.
    Enter a client name and description and click create.
  4. 4.
    A pop-up will open with your Client ID and Client Secret.
    Make a note of your Client ID and Client Secret because they will never be shown again. You will need them to configure Airbyte Zuora Connector.
  5. 5.
    You're ready to set up Zuora connector in Airbyte, using created Client ID and Client Secret!

Changelog

Version
Date
Pull Request
Subject
0.1.3
2021-10-16
7053
Added support of Unlimited option for Data Query
0.1.2
2021-10-11
6960
Change minimum value for Window_in_days to 1, instead of 30
0.1.1
2021-10-01
6575
Added OAuth support for Airbyte Cloud
0.1.0
2021-08-01
4661
Initial release of Native Zuora connector for Airbyte
Last modified 2mo ago