# Zuora Import Integration

You can import Zuora Data Source objects, such as accounts and invoices, into Treasure Data. The modes of import are:

- base
- fetch-related


In a fetch-related import, you can specify the import of Full objects, which includes all pre-joined objects.

## Prerequisites

- Basic knowledge of Treasure Data
- Basic knowledge of Zuora


## Limitations

- Zuora Import Integration uses Zuora SOAP API internally. This API is available on Zuora US Data Center Customers.
- If you are a Zuora EU Data Center Customer and would like to use this integration, contact your Customer Success representative.


## Use TD Console

### Create a new connection

1. Go to **Integrations Hub > Catalog** and search Zuora.
2. Select Zuora.
![](/assets/image-20191022-134041.97acb8ec20146253a30e1d386dc86d613016642bf6751553e2f7176f20e4bd51.b7743126.png)
3. Complete the Zuora login information, select **Next** and provide a connection name:
![](/assets/image-20191022-134049.232cabf5285a99606bc9c375568b921235c99ef6e81efd5f3bf0f0df83614a32.b7743126.png)


### Create a new transfer

After creating the connection, you are automatically taken to the Authentications page. Look for the connection you created and select **New Transfer**.

![](/assets/image-20191209-222740.9cc97d1340b767b01f487643a5785b34bc309b1aead0a48834382b3653756922.b7743126.png)

Provide information details and select **Next**.

![](/assets/image-20191022-134100.e555ee1bfa1b13050efd82aa73399ae5c1fd992f00464a2141302b6ded23ffb8.b7743126.png)

**Fetch related objects**: Most of Zuora’s data sources provide related business objects, which eliminates the need to construct nested queries and improves performance. If you need the related business objects data, check the box and select the data source you want to query.

**API Version (default v85)**: Zuora SOAP API Version. Support for v85 and forward.

**Duration to import**: This option enables you to select the 'end_date' based on the 'start_date' of import.

- If **Start date** is set to = 02/07/2017, 12:00 AM AND **Number of Unit** = 1 DAY, your data transfer includes all data available up until 02/08/2017, 12:00 AM.


In this example, the 'end_date' is calculated as follows:


```
'start_date' + 'number_of_unit' = 'end_date'
02/07/2017, 12:00AM + 1 DAY = 02/08/2017, 12:00AM
```

- If the transfer is scheduled, the 'start_date' constantly changes based on the new 'end_date' since the last import (as calculated previously).
- If incremental is not selected, import is from 'start_date' to now.
- User timezone is reserved.


Treasure Data highly recommends you re-create a transfer if you’d want to change the 'start_date'. Editing an existing transfer does not affect the 'start_date'.

Preview your data. If you want to change anything, select **Advanced Settings** or else select  **Next**.

![](/assets/image-20191022-134115.782327cf5066ade2eb255a890e644c71418a397ae8f4507e0d022d0187fcfdb2.b7743126.png)

Select the database and table where you want to transfer the data:

![](/assets/image-20191022-134127.570a6c23e21e341b7de52b942e6622f51aa9747cc2f2da5db1606cf078e054b1.b7743126.png)

Specify the schedule of the data transfer and click Start Transfer:

![](/assets/image-20191022-134134.39cd15fd204aef50837fe8d503e9b127101d4c412fb2113dfae4aad0eb41a006.b7743126.png)

You will see the new data transfer in progress, listed under the My Input Transfers tab, and a corresponding job will be listed in the Jobs section.

## Use Command Line

### Install ‘td’ command v0.11.9 or later

You can install the newest [TD Toolbelt](https://toolbelt.treasuredata.com/).


```
$ td --version
0.15.0
```

### Create Configuration File

Prepare configuration file (for eg: `load.yml`), as shown in the following example, with your Zuora account access information.


```yaml
in:
  type: zuora
  username: xxxxxxxx
  password: xxxxxxxx
  base_object: Account #(required if fetch_related = false, see Appendix B)
  data_source: Account #(required if fetch_related = true, see Appendix C)
  fetch_related: true #(optional, default: false)
  from_timestamp: 12-05-2016T11:00:00.000Z
  incremental: true #(optional, default: true)
  duration: { unit: DAY, num: 1 } #(required if `incremental: true`)
out:
  mode: replace
```

This example dumps Zuora Account Data Source:

- username and password: your login information.
- describe_api_verion: Zuora Describe API version, See [Zuora Describe API](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL/Changes_to_the_Describe_API)
- base_object: name of Zuora SOAP (Base) Object you want to import, required if fetch_related: false
  - See the [Appendix](/int/zuora-import-integration#h1__1835053169) for list of available base objects.
- data_source: name of Zuora Data Source you want to import, required if fetch_related: true
  - See the [Appendix](/int/zuora-import-integration#h1__1835053169) for list of available data sources.
- fetch_related: you can choose to import **base** or **full** object (including all pre-joined objects), default as false
- from_timestamp: from which moment data will be imported, format is: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
- incremental: should data import be continuous or once, default as true. If true, duration is required
- duration: for how long will data be imported, determined by UpdatedDate field of target object. unit has 3 options: DAY, HOUR, and MIN, default as DAY.


Some Limited Availability objects from Zuora require additional configuration settings. The following is a list of additional configuration settings for Billing Preview Run

- from_timestamp : When used with Billing Preview Run, this is the Target Date for the preview run.
- include_evergreen_sub : Indicate whether to include the evergreen subscription. The default is ‘false’
- batch : Specify customer batch to include in this preview run
- assume_renewal : Whether to assume renewal for the accounts. Valid value is All, None or Autorenew. The default is ‘None’.
- charge_type_to_exclude : The charge types to exclude from the forecast run. Possible values: OneTime, Recurring, Usage, and any comma-separated combination of these values.


For more details on available out modes, see the [Appendix](/int/zuora-import-integration#h1__1835053169).

### Preview data to import

You can preview data to be imported using the command td connector:preview.


```bash
td connector:preview load.yml
```

### Execute Load Job

Submit the load job. It may take a couple of hours depending on the data size. Users need to specify the database and table where their data are stored.

It is recommended to specify --time-column option, because Treasure Data’s storage is partitioned by time (see also [data partitioning](https://docs.treasuredata.com/smart/project-product-documentation/data-partitioning-in-treasure-data)). If the option is not given, the Data Connector chooses the first long or timestamp column as the partitioning time. The type of the column specified by --time-column must be either of long and timestamp type.

If your data doesn’t have a time column you can add it using add_time filter option. More details at [add_time filter plugin](https://docs.treasuredata.com/smart/project-product-documentation/add_time-filter-function)


```bash
td connector:issue load.yml \
--database td_sample_db --table td_sample_table \
--time-column updated_date
```

The connector:issue command assumes you have already created *database(td_sample_db)* and *table(td_sample_table)*. If the database or the table do not exist in TD, the command fails, so create the database and table [manually](https://docs.treasuredata.com/smart/project-product-documentation/data-management) or use --auto-create-table option with td connector:issue command to auto create the database and table:


```bash
td connector:issue load.yml \
--database td_sample_db --table td_sample_table \
--time-column updated_date --auto-create-table
```

You can assign Time Format column to the "Partitioning Key" by "--time-column" option.

### Scheduled execution

You can schedule periodic Data Connector execution for periodic Zuora import. The load distribution and operation of Treasure Data’s scheduler is optimized to achieve high availability. By using Treasure Data’s scheduler, you no longer need a cron daemon on your local data center.

### Create the schedule

A new schedule can be created using the td connector:create command. Specify the name of the schedule, the cron-style schedule, the database and table where the data will be stored, and the Data Connector configuration file. The values are required.


```bash
td connector:create \
daily_zuora_import \
"10 0 * * *" \
td_sample_db \
td_sample_table \
load.yml
```

The 'cron' parameter also accepts these three options: '@hourly', '@daily' and '@monthly'.

By default, schedule is setup in UTC timezone. You can set the schedule in a timezone using -t or —timezone option. Note that --timezone option only supports extended timezone formats like ‘Asia/Tokyo’, ‘America/Los_Angeles’ etc. Timezone abbreviations like PST, CST are *not* supported and may lead to unexpected schedules.

### List the Schedules

You can see the list of scheduled entries by `td connector:list`.


```
$ td connector:list
```

### Show the Setting and History of Schedules

td connector:show shows the execution setting of a schedule entry.


```
td connector:show daily_zuora_import
```

### Delete the Schedule

td connector:delete removes the schedule.


```
$ td connector:delete daily_zuora_import
```

## Available Base Object

| **Base Object** | **Base Object** | **Base Object** |
|  --- | --- | --- |
| Account | InvoiceItem. | ProductRatePlanChargeTier |
| AccountingCode | InvoiceItemAdjustment | RatePlan |
| AccountingPeriod | InvoicePayment | RatePlanCharge |
| BillingRun | Payment | RatePlanChargeTier |
| BillingPreviewRun | PaymentMethod | Refund |
| ChargeMetrics | PaymentMethodTransactionLog | RefundInvoicePayment |
| Contact | PaymentTransactionLog | RefundTransactionLog |
| CreditBalanceAdjustment | Product | Subscription |
| Feature | ProductFeature | SubscriptionProductFeature |
| Invoice | ProductRatePlan | TaxationItem |
| InvoiceAdjustment | ProductRatePlanCharge | Usage |


## Available Data Source

| **Data Source** | **Data Source** | **Data Source** |
|  --- | --- | --- |
| Account | Payment | RatePlanChargeTier |
| AccountingCode | PaymentGatewayReconciliationEventLog | RevenueChargeSummaryItem |
| BillingRun | PaymentMethod | RevenueEventItem |
| Contact | PaymentMethodTransactionLog | RevenueEventItemCreditMemoItem |
| ChargeMetrics | PaymentPart | RevenueEventItemDebitMemoItem |
| CreditBalanceAdjustment | PaymentPartItem | RevenueEventItemInvoiceItem |
| Invoice | PaymentReconciliationLog | RevenueEventItemInvoiceItemAdjustment |
| InvoiceAdjustment | PaymentTransactionLog | RevenueScheduleItem |
| InvoiceItemAdjustment | ProcessedUsage | RevenueScheduleItemInvoiceItem |
| InvoicePayment | Product | RevenueScheduleItemInvoiceItemAdjustment |
| JournalEntryItem | ProductRatePlanChargeTier | RevenueScheduleItemCreditMemoItem |
| Order | RatePlan | RevenueScheduleItemDebitMemoItem |
| OrderAction | RatePlanCharge | Subscription |
| OrderQuantity | RatePlanChargeTier | SubscriptionProductFeature |
| OrderMrr | Refund | UpdaterDetail (PaymentMethodUpdate) |
| OrderTcb | RefundInvoicePayment | Usage |
| OrderTcv | RefundTransactionLog |  |


## Configure excluded fields for Base Object

When you import data for Base Object, some special fields are excluded by default. This is due to limitations or restrictions applied on each Base Object by Zuora.

For example: RatePlanCharge DiscountAmount can not be queried together with the following fields: Price, IncludedUnits, DiscountPercentage, OveragePrice. The plugin defaults to exclude the fields. You can change the excluded fields list in the Advanced Configuration UI. Advanced Configuration automatically populate the list of Base Object excluded fields.

Steps to change excluded fields:

1. In base object preview screen, choose **Advanced Settings**.
2. The **Advanced Settings** contains a list of predefined excluded fields, if any exist. You can replace or change the fields as well. But be aware that some fields cannot be included together.


![](/assets/image-20191022-134606.3570724ecc39b98a70aa6127bcdbc1adec43bd890f6fa0ac9dba6c813f61f1c0.b7743126.png)

![](/assets/image-20191022-134616.fb4954cffe0b4a7596f74a21eadb15fcf2c3cd1d365f1c58070932ffd79d99a6.b7743126.png)

Excluded fields configuration only works with Base Object targets, and will be ignored for Data Source targets

## Customize timestamp column

### Timestamp column

The Timestamp column is the Zuora object column that the data connector uses to apply a time range filter. The column defaults to UpdatedDate or a pre-configured column in plugin internal configuration.

| Zuora Object | Incremental Column |
|  --- | --- |
| PaymentGatewayReconciliationEventLog | CreatedDate |
| PaymentMethodTransactionLog | TransactionDate |
| PaymentReconciliationLog | CreatedDate |
| PaymentTransactionLog | TransactionDate |
| RefundTransactionLog | TransactionDate |


All other supported Zuora objects that are not listed in the preceding table use the default column *UpdatedDate*.

### Customize timestamp column

Sometimes you might want to use a different column as a timestamp column. You can specify a column through the Timestamp column configuration in **Advanced Configuration** screen.

![](/assets/image-20191022-134643.6a0401ccf542a5ec558824040b0f8eb174bab2f2288355f4321bc387a245b242.b7743126.png)

The parameter value will have the same format with Zuora ZOQL filter, *ObjectName.ColumnName*, Example : RatePlanCharge.UpdatedAt, RatePlan.UpdatedAt, RatePlanChargeTier.UpdatedAt.

The Column used as a timestamp column must have a DateTime data type in Zuora.