Search documentation...

K

Zuora

Sync business-critical data from your data warehouse to Zuora with Hightouch

Setup

After selecting Zuora from our Destinations catalog, you will be prompted to enter your Zuora Base URL, Client ID, and Client Secret.
Use this table from Zuora to select the correct Zuora URL, and follow these steps to create an OAuth Client in Zuora that will provide you with the required Client ID and Secret.

Syncing

Hightouch supports syncing to the following Zuora objects:
  • Accounts
  • Subscriptions
  • Usage

Sync Modes

Here are the possible modes for how to alter Outreach objects:
  • Upsert — pushes new objects to Zuora and updates fields that change in your warehouse.
    • Supported for Accounts and Subscriptions.
  • Update — updates particular fields on existing objects in Zuora. It does not add new objects.
    • Supported for Accounts, Subscriptions, and Usage.
  • Insert — adds new objects in Zuora.
    • Supported for Usage.

Record Matching

Records can be matched from your source to your Zuora workspace by the given fields in the dropdown.
The following are supported record ID's for each object:
  • Accounts: Account Number, Account ID
  • Subscription: Subscription Number, Subscription ID
  • Usage: Usage Record ID
A record ID is required when performing Upsert or Update actions, but not Insert.

Field Mapping

You can sync columns from your source to Zuora's object properties, including custom fields.

Required Fields

Each object / action pair will have their own required properties to be mapped. These required properties will be in their own mapping section during sync configuration. Be sure to scroll down to our Zuora Object Notes to see which fields are required, and their respective data types.

Optional and Custom Fields

Any optional built-in fields or custom fields sent to Zuora will be mapped in the custom mappings section of sync configuration. Scroll down to our Zuora Object Notes to see Zuora's optional built-in fields, and their respective data types.

Helpful Tip:

Use our advanced mapper to fill in static values for numbers or string values that may be consistent across your sync, that may not have a column in your data warehouse. See the example below.

Zuora Object Notes

Accounts

The following fields can be used for Accounts for each respective action.
Upsert (click to view table)
Field NameNotesRequired
accountNumberstring
applyCreditboolean
applyCreditBalanceboolean
autoPayboolean
batchstring
billCycleDayinteger
billToContact.firstNamestring
billToContact.lastNamestring
collectboolean
communicationProfileIdstring
creditMemoReasonCodestring
creditMemoTemplateIdstring
crmIdstring
currencystring
debitMemoTemplateIdstring
documentDatestring
invoiceboolean
invoiceCollectboolean
invoiceTargetDatestring
invoiceTemplateIdstring
namestring
notesstring
parentIdstring
paymentGatewaystring
paymentTermstring
runBillingboolean
salesRepstring
sequenceSetIdstring
soldToSameAsBillToboolean
taggingstring
targetDatestring
Class__NSstring
CustomerType__NSstring
Department__NSstring
IntegrationId__NSstring
IntegrationStatus__NSstring
Location__Nstring
Subsidiary__NSstring
SyncDate__NSstring
SynctoNetSuite__NSstring

Update (click to view table)
Field NameNotes
autoPayboolean
batchstring
billCycleDayinteger
billToContactContact
communicationProfileIdstring
creditMemoTemplateIdstring
crmIdstring
debitMemoTemplateIdstring
defaultPaymentMethodIdstring
invoiceDeliveryPrefsEmailboolean
invoiceDeliveryPrefsPrintboolean
invoiceTemplateIdstring
namestring
notesstring
parentIdstring
paymentGatewaystring
paymentTermstring
salesRepstring
sequenceSetIdstring
soldToContactContact
taggingobject
Class__NSstring
CustomerType__NSstring
Department__NSstring
IntegrationId__NSstring
IntegrationStatus__NSstring
Location__NSstring
Subsidiary__NSstring
SyncDate__NSstring
SynctoNetSuite__NSstring
Notes:
  • By default, autoPay is set to false for inserted Accounts, unless it is defined in the mappings for your sync.
    • If you would like to set autoPay to true, you must include either a paymentMethod, creditCard, or hmpCreditCardPaymentMethodId in your mappings.
  • If either the workEmail or personalEmail fields are included in mappings, the account's email delivery preference is autoamtically set to true.
  • To see more information on any respective field, view the Zuora API docs for Creating an account or Updating an account via the API.

Subscriptions

The following fields can be used for Subscriptions for each respective action.
Upsert (click to view table)
Field NameNotesRequired
accountKeystring
applyCreditboolean
applyCreditBalanceboolean
autoRenewboolean
collectboolean
contractEffectiveDatestring
creditMemoReasonCodestring
customerAcceptanceDatestring
documentDatestring
externallyManagedBystring
gatewayIdstring
initialTerminteger
initialTermPeriodTypestring
invoiceboolean
invoiceCollectboolean
invoiceOwnerAccountKeystring
invoiceSeparatelyboolean
invoiceTargetDatestring
notesstring
paymentMethodIdstring
renewalSettingstring
renewalTerminteger
renewalTermPeriodTypestring
runBillingboolean
serviceActivationDatestring
subscriptionNumberstring
subscribetoRatePlans.productRatePlanIdstring
targetDatestring
termStartDatestring
termTypestring
CpqBundleJsonId**QTstring
OpportunityCloseDate**QTstring
OpportunityName**QTstring
QuoteBusinessType**QTstring
QuoteNumber**QTstring
QuoteType**QTstring
IntegrationId**NSstring
IntegrationStatus**NSstring
Project**NSstring
SalesOrder**NSstring
SyncDate__NSstring

Update (click to view table)
Field NameNotes
addArray of objects
applicationOrderArray of strings
applyCreditboolean
applyCreditBalanceboolean
autoRenewboolean
clearingExistingBillToContactIdboolean
clearingExistingPaymentTermboolean
collectboolean
creditMemoReasonCodestring
currentTerminteger
currentTermPeriodTypestring
documentDatestring
externallyManagedBystring
includeExistingDraftDocItemsboolean
includeExistingDraftInvoiceItemsboolean
invoiceboolean
invoiceCollectboolean
invoiceSeparatelyboolean
invoiceTargetDatestring
notesstring
previewboolean
previewTypestring
renewalSettingstring
renewalTerminteger
renewalTermPeriodTypestring
runBillingboolean
targetDatestring
termStartDatestring
termTypestring
CpqBundleJsonId__QTstring
OpportunityCloseDate__QTstring
OpportunityName__QTstring
QuoteBusinessType__QTstring
QuoteNumber__QTstring
QuoteType__QTstring
IntegrationId__NSstring
IntegrationStatus__NSstring
Project__NSstring
SalesOrder__NSstring
SyncDate__NSstring
Notes:
  • Only the fields to be changed should be specified. If an empty field is submitted with this operation, the corresponding field in the account is emptied.
  • To see more information on any respective field, view the Zuora API docs for Creating a subscription or Updating a subscription via the API.

Usage

The following fields can be used for Usage for each respective action.
Insert (click to view table)
Field NameTypeRequired
AccountIdstring
AccountNumberstring
ChargeIdstring
ChargeNumberstring
Descriptionstring
EndDateTimestring <date-time>
Quantitydouble
StartDateTimestring <date-time>
SubmissionDateTimestring <date-time>
SubscriptionIdstring
SubscriptionNumberstring
UOMstring

Update (click to view table)
Field NameNotes
EndDateTimestring <date-time>
Quantitydouble
RbeStatusstring
StartDateTimestring <date-time>
SubmissionDateTimestring <date-time>
UOMstring
Notes
  • Any field with a type of string <date-time> must be in the format "YYYY-MM-DDTHH:mm:ss".
  • To see more information on any respective field, view the Zuora API docs for Creating a usage record or Updating a usage record via the API.

    Need help?

    Our team is relentlessly focused on your success. We're ready to jump on a call to help unblock you.

    • Connection issues with your data warehouse?
    • Confusing API responses from destination systems?
    • Unsupported destination objects or modes?
    • Help with complex SQL queries?

    or

    Feature Requests?

    If you see something that's missing from our app, let us know and we'll work with you to build it!

    We want to hear your suggestions for new sources, destinations, and other features that would help you activate your data.

On this page

SetupSyncingSync ModesRecord MatchingField MappingZuora Object Notes

Was this page helpful?