Advanced Analytica Advanced Analytica: IBOM
← All connectors
Zuora logo

Source connector

Zuora

Set up Zuora as a source and move its data into your chosen destination.

Version 0.1.3 archived alpha

Zuora

:::warning

Deprecation notice

The Zuora source connector is scheduled for deprecation on 5 March 2024. It is incompatible with upcoming platform updates for Airbyte 1.0. After deprecation, the connector won’t be supported or available in Airbyte.

This connector doesn’t support the new per-stream features needed to protect data integrity during Airbyte synchronisation. Without these features, Airbyte can’t enforce its reliability and correctness standards for data syncing operations.

To continue syncing this data, consider creating a custom connector as an alternative. For guidance, visit Custom Connector documentation.

:::

Sync overview

The Zuora source supports Full Refresh and Incremental syncs. You can copy only new or updated data with each sync. Alternatively, copy every row from the tables and columns you’ve configured for replication.

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.

Output schema

This source can sync:

  • standard objects available in your Zuora Account
  • custom objects you’ve manually added and that are available in your Zuora Account
  • custom fields in standard and custom objects that are available in your Zuora Account

Discovering your Zuora Account object schema may take some time when you first add the connection. It may also take time when you refresh the available streams. Don’t cancel this operation while it runs. It usually takes 5-10 min, depending on the number of objects available in your Zuora Account.

Note

Some Zuora Objects may be unavailable for syncing because of Zuora Supscription Plan or Permissions limitations. See the Availability of Data Source Objects section in the Zuora documentation for details.

Data type mapping

Integration TypeAirbyte TypeNotes
decimal(22,9)numberfloat number
decimalnumberfloat number
floatnumberfloat number
doublenumberfloat number
integernumber
intnumber
bigintnumber
smallintnumber
timestampnumbernumber representation of the unix timestamp
datestring
datetimestring
timestamp with time zonestring
pickliststring
textstring
varcharstring
zoqlobject
binaryobject
jsonobject
xmlobject
blobobject
listarray
arrayarray
booleanboolean
boolboolean

Any data type not listed in the table above is treated as string.

Features

FeatureSupported?(Yes/No)Notes
Full Refresh Overwrite SyncYes
Full Refresh Append SyncYes
Incremental - Append SyncYes
Incremental - Append + Deduplication SyncYes
NamespacesNo

Supported Zuora environments

EnvironmentSupported?(Yes/No)Notes
ProductionYesSelect from exising options while setup
SandboxYesSelect from exising options while setup

Supported data query options

OptionSupported?(Yes/No)Notes
LIVEYesRun data queries against Zuora live transactional databases
UNLIMITEDYesRun 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.)

Supported Zuora environments

Production

EnvironmentEndpoint
US Productionrest.zuora.com
US Cloud Productionrest.na.zuora.com
EU Productionrest.eu.zuora.com

Sandbox

EnvironmentEndpoint
US API Sandboxrest.apisandbox.zuora.com
US Cloud API Sandboxrest.sandbox.na.zuora.com
US Central Sandboxrest.test.zuora.com
EU API Sandboxrest.sandbox.eu.zuora.com
EU Central Sandboxrest.test.eu.zuora.com

Other

EnvironmentEndpoint
US Performance Testrest.pt1.zuora.com

For more information about available environments, visit this page.

Performance considerations

If your sync takes a long time, consider these options:

  • increase the window_in_days parameter in the Zuora source configuration
  • use a smaller date range by adjusting the start_date parameter

Note

The first sync for all objects in your Zuora Account usually takes 25-45-60 min. More data requires more time.

Get started

Create an API user role

  1. Log in to your Zuora acccount.
  2. In the Zuora dashboard’s top-right corner, select Settings > Administration Settings.
  3. Select Manage User Roles.
  4. Select Add new role to create a new role, then complete the required form fields.

Assign the role to a user

  1. From the administration page, select Manage Users.

  2. Select add single user.

  3. Create a user and assign the role you created in the Create an API user role section.

  4. You’ll 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. From the administration page, select Manage Users.

  2. Select the User Name of the target user.

  3. Enter a client name and description, then select create.

  4. A pop-up opens with your Client ID and Client Secret.

    Save your Client ID and Client Secret because they won’t be shown again. You’ll need them to configure Airbyte Zuora Connector.

  5. You can now set up Zuora connector in Airbyte using the created Client ID and Client Secret.

IP allow list

If you use Airbyte Cloud and your organisation restricts access to specific IPs, add the Airbyte Cloud IP addresses to your allow list.

Changelog

Expand to review
VersionDatePull RequestSubject
0.1.32021-10-167093Added support of Unlimited option for Data Query
0.1.22021-10-116960Change minimum value for Window_in_days to 1, instead of 30
0.1.12021-10-016575Added OAuth support for Airbyte Cloud
0.1.02021-08-014661Initial release of Native Zuora connector for Airbyte
Advanced Analytica

Most businesses are sitting on information they can’t use at speed. The people who hold it are busy, and when they leave, the knowledge goes with them. The documents are static, and the processes around them weren’t designed for AI.

Advanced Analytica works with these businesses to turn that information into structured data assets. Once they're integrated, AI systems can govern it, and the business can use it. We bring in the strategy, the specification and the AI skills to rework how the business operates.

MOVE FAST. STAY SAFE.