Zuora integration summary

Stitch’s Zuora integration can use one of two APIs: REST API and AQuA API. When setting up the integration in Stitch, you can choose which API to use.

Additionally, Stitch supports replicating custom fields for any object that supports custom fields in Zuora. Custom fields are supported for both the REST API and AQuA API.

Note: Each API has its benefits and limitations. For example: With the AQuA API, you can replicate large data sets and deleted records for objects that support it. Once an integration is saved, the API selected can’t be changed. Learn more about the APIs.

Refer to the Schema section for a list of objects available for replication.

Zuora feature snapshot

A high-level look at Stitch's Zuora (v1) integration, including release status, useful links, and the features supported in Stitch.

STITCH
Release status

Released on April 17, 2018

 Supported by

Stitch
Stitch plan

Standard

 API availability

Available
Singer GitHub repository

singer-io/tap-zuora
REPLICATION SETTINGS
Anchor Scheduling

Supported

 Advanced Scheduling

Supported
Table-level reset

Unsupported

 Configurable Replication Methods

Unsupported
DATA SELECTION
Table selection

Supported

 Column selection

Supported
Select all

Supported
TRANSPARENCY
Extraction Logs

Supported

 Loading Reports

Supported

Connecting Zuora

Zuora setup requirements

To set up Zuora in Stitch, you need:

  • Administrator permissions in Zuora. These permissions are required to create a Zuora user for Stitch.

Step 1: Create a Stitch Zuora user

In this step, you’ll create a Zuora user for Stitch. Creating a Stitch-specific user will ensure that Stitch is distinguishable in any logs or audits.

Create the Zuora user

Zuora user permissions

  1. Sign into your Zuora account, if you haven’t already.
  2. Click your username in the top-right corner.
  3. Click Administration, then Manage Users.
  4. Click Add Single User.
  5. Enter a first and last name for the user.
  6. Enter an email address in the Work Email field.
  7. Enter an email address in the Login Field.
  8. In the Zuora Platform Role field, select Standard User.
  9. For the remaining Role fields, select the Standard User option.
  10. There aren’t any requirements for the Locale and Language fields - leave them as the defaults.
  11. Click Save to create the user.

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

Step 2: Add Zuora as a Stitch data source

  1. Sign into your Stitch account.

  2. On the Stitch Dashboard page, click the Add Integration button.

  3. Click the Zuora icon.

  4. Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

    For example, the name “Stitch Zuora” would create a schema called stitch_zuora in the destination. Note: Schema names cannot be changed after you save the integration.

  5. If the Zuora instance you want to connect to Stitch is a sandbox, check the Connect to a Sandbox Environment checkbox.
  6. In the Username field, enter the Stitch Zuora user’s username. This is the email address that was in the Login Name field when you created the user.
  7. In the Password field, enter the password associated with the Stitch Zuora user.
  8. If the Zuora instance you want to connect to Stitch is a sandbox, check the Connect to a Sandbox Environment box.
  9. If the Zuora instance you want to connect to Stitch is based in Europe, check the Connect to a European endpoint box. If you aren’t sure if this is applicable to you, refer to Zuora’s documentation.

Step 3: Select a Zuora extraction API

Stitch’s Zuora integration gives you the ability to select the API that you want Stitch to use to extract data. If you aren’t sure which API you should use, take a look at the brief comparison below.

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

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

REST API AQuA API
Good for replicating

Small data sets, more frequently

Large data sets, 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

Refer to 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.

Step 4: Define the historical replication start date

The Sync Historical Data setting defines the starting date for your Zuora integration. This means that data equal to or newer than this date will be replicated to your data warehouse.

Change this setting if you want to replicate data beyond Zuora’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.

Step 5: Create a replication schedule

In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

Zuora integrations support the following replication scheduling methods:

To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.

Step 6: Set objects to replicate

The last step is to select the tables and columns you want to replicate. Learn about the available tables for this integration.

Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.

For Zuora integrations, you can select:

  1. Individual tables and columns

  2. All tables and columns

Click the tabs to view instructions for each selection method.

  1. In the integration’s Tables to Replicate tab, locate a table you want to replicate.

  2. To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.

  3. To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.

  4. Repeat this process for all the tables and columns you want to replicate.
  5. When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
  1. Click into the integration from the Stitch Dashboard page.

  2. Click the Tables to Replicate tab.

  3. In the list of tables, click the box next to the Table Names column.

  4. In the menu that displays, click Track all Tables and Fields:

    The Track all Tables and Fields menu in the Tables to Replicate tab

  5. Click the Finalize Your Selections button at the bottom of the page to save your data selections.

Initial and historical replication jobs

After you finish setting up Zuora, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.

Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.

Zuora replication

Replicate deleted data

If using the AQuA API for data extraction, deleted data will be replicated for objects that support it. Supported objects will contain a boolean column named deleted that indicates a record’s deletion status.

Note: This column won’t be automatically included for replication - it must be set to replicate.

Deleted data is supported for all objects with the exception of the following:

  • accountingPeriod

  • contactSnapshot

  • discountAppliedMetrics

  • paymentGaterwayReconciliationEventLog

  • paymentTransactionLog

  • paymentMethodTransactionLog

  • paymentReconciliationJob

  • paymentReconciliationLog

  • processedUsage

  • refundTransactionLog

  • updaterBatch

  • updaterDetail

Custom field replication

Custom object properties, or attributes, are supported by Stitch’s Zuora integration. If custom fields are available through Zuora’s API, Stitch will replicate them to your destination.

This is applicable to any object that supports custom fields in Zuora. Refer to Zuora’s documentation for info on which objects support custom fields.

Unsupported objects

Stitch’s Zuora integration doesn’t currently support replication for the following objects:

  • discountApplyDetail

  • invoiceFile

  • paymentMethodSnapshot

  • productDiscountApplyDetail

  • unitOfMeasure

Zuora table reference

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 data sets will allow you to perform more in-depth and complex analyses.

Don’t see a table listed here? The list of tables shown below is not an exhaustive list of all the tables Stitch can replicate from Zuora.

We’re working on adding documentation for additional Zuora tables. If there’s a specific table you’d like to see here, let us know by opening an issue in the Stitch Docs GitHub repo.

account

Replication Method :

Key-based Incremental

 Replication Key :

updatedDate
Primary Key :

id

 Official docs :

Official Docs

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

account table schema

id
STRING

The account ID.

Reference:

updatedDate
DATE-TIME

The date when the account was last updated.

accountNumber
STRING

The unique account number assigned to the account.

additionalEmailAddresses
STRING

A list of additional email addresses to receive emailed invoices.

allowInvoiceEdit
BOOLEAN

If true, the account’s associated invoices may be edited.

autoPay
BOOLEAN

If true, future payments for the account are automatically collected when they’re due during a Payment Run.

balance
DECIMAL

The current outstanding balance for the account.

batch
STRING

The batch group the account is a part of.

bcdSettingOption
STRING

The billing cycle day setting option for the account.

billCycleDay
INTEGER

The billing cycle day (BCD) on which bill runs generate invoices for the account.

billToContactId
STRING

The ID of the person to bill for the account.

Reference:

communicationProfileId
STRING

The ID of the communication profile associated with the account.

Reference:

createdById
STRING

The ID of the Zuora user who created the account.

createdDate
DATE-TIME

The date when the account was created.

creditBalance
DECIMAL

The total credit balance for the account.

crmId
STRING

The CRM account ID for the account. Used when Salesforce is integrated with your Zuora instance.

currency
STRING

The currency that the customer is billed in.

customerServiceRepName
STRING

The name of the account’s customer service representative, if applicable.

defaultPaymentMethodId
STRING

The ID of the default payment method for the account.

Reference:

deleted
BOOLEAN

Only supported for the AQuA API. If true, this record was deleted in Zuora.

invoiceDeliveryPrefsEmail
BOOLEAN

If true, the customer wants to receive invoices through email.

invoiceDeliveryPrefsPrint
BOOLEAN

If true, the customer wants to receive printed invoices.

invoiceTemplateId
STRING

The ID of the invoice template used for the account.

lastInvoiceDate
DATE-TIME

The date when the previous invoice was generated for the account. This field will be NULL if no invoice has ever been generated for the account.

name
STRING

The name of the account as displayed in the Zuora UI.

notes
STRING

Any comments about the account.

parentAccountId
STRING

The ID of the parent customer account for this account. This field is used when customer hierarchy is enabled in Zuora.

Reference:

paymentGateway
STRING

The gateway used for processing electronic payments and refunds.

paymentTerm
STRING

Indicates when the customer pays for subscriptions.

purchaseOrderNumber
STRING

The number of the purchase order associated with this account.

salesRepName
STRING

The name of the sales representative associated with the account, if applicable.

soldToContactId
STRING

The ID of the person who bought the subscription associated with the account.

Reference:

status
STRING

The status of the account in the system. Possible values are:

  • Draft
  • Active
  • Canceled

taxExemptCertificateId
STRING

The ID of the customer’s tax exemption certificate.

taxExemptCertificateType
STRING

The type of tax exemption certificate that the customer holds.

taxExemptDescription
STRING

The description of the tax exemption certificate that the customer holds.

taxExemptEffectiveDate
DATE-TIME

The date when the customer’s tax exemption starts.

taxExemptExpirationDate
DATE-TIME

The date when the customer’s tax exemption expires.

taxExemptIssuingJurisdiction
STRING

The jurisdiction in which the customer’s tax exemption certificate was issued.

taxExemptStatus
STRING

The status of the account’s tax exemption. Possible values are:

  • Yes
  • No
  • PendingVerification

totalInvoiceBalance
DECIMAL

The total balance of the account’s invoices.

updatedById
STRING

The ID of the Zuora user who last updated the account.

accountingCode

Replication Method :

Key-based Incremental

 Replication Key :

updatedDate
Primary Key :

id

 Official docs :

Official Docs

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.

accountingCode table schema

id
STRING

The accounting code ID.

updatedDate
DATE-TIME

The date when the accounting code was last updated.

category
STRING

The category associated with the accounting code. Possible values are:

  • Assets
  • Liabilities
  • Equity
  • Revenue
  • Expenses

createdById
STRING

The ID of the Zuora user who created the accounting code.

createdDate
DATE-TIME

The date when the accounting code was created.

deleted
BOOLEAN

Only supported for the AQuA API. If true, this record was deleted in Zuora.

glAccountName
STRING

The name of the account in your general ledger.

glAccountNumber
STRING

The account number in your general ledger.

name
STRING

The name of the accounting code.

notes
STRING

Additional notes about the accounting code.

status
STRING

The status of the accounting code. Possible values are:

  • Active
  • Inactive

type
STRING

The accounting code type. Possible values are:

  • AccountsReceivable
  • On-Account Receivable
  • Cash
  • OtherAssets
  • CustomerCashOnAccount
  • DeferredRevenue
  • SalesTaxPayable
  • OtherLiabilities
  • SalesRevenue
  • SalesDiscounts
  • OtherRevenue
  • OtherEquity
  • BadDebt
  • OtherExpenses

updatedById
STRING

The ID of the Zuora user who last updated the accounting code.

accountingPeriod

Replication Method :

Key-based Incremental

 Replication Key :

updatedDate
Primary Key :

id

 Official docs :

Official Docs

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

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

accountingPeriod table schema

id
STRING

The accounting period ID.

Reference:

updatedDate
DATE-TIME

The date when the accounting period was last updated.

createdById
STRING

The ID of the Zuora user who created the accounting period.

createdDate
DATE-TIME

The date when the accounting period was created.

endDate
DATE-TIME

The end date of the accounting period.

fiscalQuarter
STRING

The fiscal quarter of the accounting period.

fiscalYear
STRING

The fiscal year of the accounting period.

name
STRING

The name of the accounting period.

notes
STRING

Additional notes about the accounting period.

runTrialBalanceEnd
DATE-TIME

The date that the trial balance was completed.

runTrialBalanceErrorMessage
STRING

If the runTrialBalanceStatus field has an Error value, this field will contain the error message for the error.

runTrialBalanceStart
DATE-TIME

The date that the trial balance was run.

runTrialBalanceStatus
STRING

The status of the trial balance for the accounting period. Possible values are:

  • Pending
  • Processing
  • Completed
  • Error

startDate
DATE-TIME

The start date of the accounting period.

status
STRING

The status of the accounting period. Possible values are:

  • Open
  • PendingClose
  • Closed

updatedById
STRING

The ID of the Zuora user who last updated the accounting period.

amendment

Replication Method :

Key-based Incremental

 Replication Key :

updatedDate
Primary Key :

id

 Official docs :

Official Docs

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.

amendment table schema

id
STRING

The amendment ID.

Reference:

updatedDate
DATE-TIME

The date when the amendment was last updated.

autoRenew
BOOLEAN

If true, the subscription will auto-renew at the end of the term.

code
STRING

A unique string that identifies the amendment.

contractEffectiveDate
DATE-TIME

The date when the amendment’s charges become effective for billing purposes.

createdById
STRING

The ID of the Zuora user who created the amendment.

createdDate
DATE-TIME

The date when the amendment was created.

currentTerm
INTEGER

The length of the period for the current subscription term. This field is used with the currentTermPeriodType field to specify the current subscription term.

currentTermPeriodType
STRING

The period type for the current subscription term. This field is used with the currentTerm field to specify the current subscription term.

Possible values are:

  • Month
  • Year
  • Day
  • Week

customerAcceptanceDate
DATE-TIME

The date when the customer accepted the amendment’s changes to the subscription.

deleted
BOOLEAN

Only supported for the AQuA API. If true, this record was deleted in Zuora.

description
STRING

The description of the amendment.

effectiveDate
DATE-TIME

The date when the amendment’s charges take effect.

name
STRING

The name of the amendment.

renewalSetting
STRING

Indicates whether a termed subscription will remain termed or change to evergreen when renewed. Possible values are:

  • RENEW_WITH_SPECIFIC_TERM
  • RENEW_TO_EVERGREEN

renewalTerm
STRING

The term of the renewal for the amended subscription. This field is used with the `renewalTermPeriodType’ field to specify the subscription renewal term.

renewalTermPeriodType
STRING

The period type for the subscription renewal term. This field is used with the `renewalTerm’ field to specify the subscription renewal term.

Possible values are:

  • Month
  • Year
  • Day
  • Week

serviceActivationDate
DATE-TIME

The date when service is activated.

specificUpdateDate
DATE-TIME

The date when the UpdateProduct amendment takes effect. Only applicable if there is already a future-dated UpdateProduct amendment on the subscription.

status
STRING

The status of the amendment. Possible values are:

  • Draft
  • Pending Activation
  • Pending Acceptance
  • Completed

subscriptionId
STRING

The ID of the subscription that the amendment changes.

Reference:

termStartDate
STRING

Indicates if the subscription is TERMED or EVERGREEN.

type
STRING

The type of amendment. Possible values are:

  • Cancellation
  • NewProduct
  • OwnerTransfer
  • RemoveProduct
  • Renewal
  • UpdateProduct
  • TermsAndConditions
  • SuspendSubscription
  • ResumeSubscription

updatedById
STRING

The ID of the Zuora user who last updated the amendment.

billingRun

Replication Method :

Key-based Incremental

 Replication Key :

updatedDate
Primary Key :

id

 Official docs :

Official Docs

The billingRun table contains information about billing runs.

billingRun table schema

id
STRING

The ID of the billing run.

updatedDate
DATE-TIME

The date when the billing run was last updated.

autoEmail
BOOLEAN

Note: Only available if the Support Billing Run Auto-Post Billing Rule is enabled.

If true, email invoices will auto-send when the billing run completes.

autoPost
BOOLEAN

Note: Only available if the Support Billing Run Auto-Post Billing Rule is enabled.

If true, the billing run will auto-post upon completion.

autoRenewal
BOOLEAN

Indicates if auto-renew subscriptions should be determined by the billing run.

batch
STRING

The batch of accounts for the billing run.

billCycleDay
STRING

The day of the billing cycle.

billRunNumber
STRING

The billing run number.

chargeTypeToExclude
STRING

The charge type(s) to be excluded from the billing run.

createdById
STRING

The ID of the Zuora user who created the billing run.

createdDate
DATE-TIME

The date when the billing run was created.

deleted
BOOLEAN

Only supported for the AQuA API. If true, this record was deleted in Zuora.

errorMessage
STRING

The error message for the billing run.

executedDate
DATE-TIME

The execute date for the billing run.

invoiceDate
DATE-TIME

The invoice date for the billing run.

invoicesEmailed
BOOLEAN

If true, the invoice has been sent.

lastEmailSentTime
DATE-TIME

The last time emails were sent for the billing run.

noEmailForZeroAmountInvoice
BOOLEAN

If true, invoices with a zero total (0) will not recieve an invoice for the billing run.

numberOfAccounts
INTEGER

The number of accounts processed by the billing run.

numberOfInvoices
INTEGER

The number of invoices generated by the billing run.

status
STRING

The status for the billing run. Possible values are:

  • Pending
  • Processing
  • Completed
  • Error
  • Canceled
  • Posted

targetDate
DATE-TIME

The target date of the billing run.

updatedById
STRING

The ID of the Zuora user who last updated the billing run.

communicationProfile

Replication Method :

Key-based Incremental

 Replication Key :

updatedDate
Primary Key :

id

 Official docs :

Official Docs

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.

communicationProfile table schema

id
STRING

The communication profile ID.

Reference:

updatedDate
DATE-TIME

The date when the communication profile was last updated.

createdById
STRING

The ID of the Zuora user who created the communication profile.

createdDate
DATE-TIME

The date when the communication profile was created.

deleted
BOOLEAN

Only supported for the AQuA API. If true, this record was deleted in Zuora.

description
STRING

The description of the communication profile.

profileName
STRING

The name of the communication profile.

updatedById
STRING

The ID of the Zuora user who last updated the communication profile.

contact

Replication Method :

Key-based Incremental

 Replication Key :

updatedDate
Primary Key :

id

 Official docs :

Official Docs

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

contact table schema

id
STRING

The contact ID.

Reference:

updatedDate
DATE-TIME

The date when the contact was last updated.

accountId
STRING

The ID of the account associated with the contact.

Reference:

address1
STRING

The first line of the contact’s address.

address2
STRING

The second line of the contact’s address.

city
STRING

The city of the contact’s address.

country
STRING

The country of the contact’s address.

createdById
STRING

The ID of the Zuora user who created the contact.

createdDate
DATE-TIME

The date the contact was created.

deleted
BOOLEAN

Only supported for the AQuA API. If true, this record was deleted in Zuora.

description
STRING

The description of the contact.

fax
STRING

The contact’s fax number.

firstName
STRING

The first name of the contact.

homePhone
STRING

The contact’s home phone number.

lastName
STRING

The last name of the contact.

mobilePhone
STRING

The contact’s mobile phone number.

nickName
STRING

The nickname for the contact.

otherPhone
STRING

The additional phone number for the contact.

otherPhoneType
STRING

The type of the otherPhone. Possible values are:

  • Work
  • Mobile
  • Home
  • Other

personalEmail
STRING

The email address of the contact.

postalCode
STRING

The zip code for the contact’s address.

state
STRING

The state or province of the contact’s address.

taxRegion
STRING

If using Zuora’s tax rules.

updatedById
STRING

The ID of the Zuora user who last updated the contact.

workEmail
STRING

The work email address of the contact.

workPhone
STRING

The contact’s work phone number.

contactSnapshot

Replication Method :

Key-based Incremental

 Replication Key :

updatedDate
Primary Key :

id

 Official docs :

Official Docs

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.

contactSnapshot table schema

id
STRING

The contact ID.

Reference:

updatedDate
DATE-TIME

The date when the contact was last updated.

accountId
STRING

The ID of the account associated with the contact.

Reference:

address1
STRING

The first line of the contact’s address.

address2
STRING

The second line of the contact’s address.

city
STRING

The city of the contact’s address.

contactId
STRING

The ID of the associated contact record.

Reference:

country
STRING

The country of the contact’s address.

createdById
STRING

The ID of the Zuora user who created the contact.

createdDate
DATE-TIME

The date the contact was created.

description
STRING

The description of the contact.

fax
STRING

The contact’s fax number.

firstName
STRING

The first name of the contact.

homePhone
STRING

The contact’s home phone number.

lastName
STRING

The last name of the contact.

mobilePhone
STRING

The contact’s mobile phone number.

nickName
STRING

The nickname for the contact.

otherPhone
STRING

The additional phone number for the contact.

otherPhoneType
STRING

The type of the otherPhone. Possible values are:

  • Work
  • Mobile
  • Home
  • Other

personalEmail
STRING

The email address of the contact.

postalCode
STRING

The zip code for the contact’s address.

state
STRING

The state or province of the contact’s address.

taxRegion
STRING

If using Zuora’s tax rules.

updatedById
STRING

The ID of the Zuora user who last updated the contact.

workEmail
STRING

The work email address of the contact.

workPhone
STRING

The contact’s work phone number.

creditBalanceAdjustment

Replication Method :

Key-based Incremental

 Replication Key :

updatedDate
Primary Key :

id

 Official docs :

Official Docs

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

creditBalanceAdjustment table schema

id
STRING

The credit balance adjustment ID.

updatedDate
DATE-TIME

The date when the credit balance adjustment was last updated.

accountId
STRING

The ID of the account associated with the contact.

Reference:

accountingCode
STRING

The accounting code associated with the adjustment.

accountingPeriodId
STRING

The ID of the accounting period associated with the adjustment.

Reference:

accountReceivableAccountingCodeId
STRING

The ID of the account’s receivable accounting code associated with the adjustment.

Reference:

adjustmentDate
DATE-TIME

The date when the adjustment was applied.

amount
DOUBLE

The amount of the adjustment.

billToContactId
STRING

The ID of the billing contact associated with the account to whom the product/service is billed.

Reference:

cancelledOn
DATE-TIME

The date when the adjustment was canceled.

cashOnAccountAccountingCodeId
STRING

The accounting code for customer cash on account.

Reference:

comment
STRING

Any comments about the adjustment.

createdById
STRING

The ID of the Zuora user who created the credit balance adjustment.

createdDate
DATE-TIME

The date when the credit balance adjustment was created.

defaultPaymentMethodId
STRING

The default payment method the associated account uses to make payments.

Reference:

deleted
BOOLEAN

Only supported for the AQuA API. If true, this record was deleted in Zuora.

invoiceId
STRING

The ID of the invoice to which the adjustment is applied.

Reference:

journalEntryId
STRING

The journal entry ID associated with the adjustment.

Reference:

journalRunId
STRING

The ID of the journal run associated with the adjustment.

number
STRING

A unique identifier for the adjustment, generated by Zuora.

parentAccountId
STRING

The ID of the parent customer account for this account. This field is used when customer hierarchy is enabled in Zuora.

Reference:

paymentId
STRING

The ID of the payment associated with the adjustment.

Reference:

paymentMethodId
STRING

The ID of the payment method associated with the adjustment.

Reference:

paymentMethodSnapshotId
STRING

The ID of the payment method snapshot associated with the adjustment.

Reference:

reasonCode
STRING

The code identifying the reason for the adjustment.

referenceId
STRING

The ID of the payment that the adjustment is for.

refundId
STRING

The ID of the refund associated with the adjustment.

Reference:

soldToContactId
STRING

The ID of the person who bought the subscription associated with the account.

Reference:

sourceTransactionId
STRING

The ID of the object that the adjustment was applied to.

Depending on the type of transaction (sourceTransactionType value), this field will be a foreign key to either the invoice, payment, or refund table.

Reference:

sourceTransactionNumber
STRING

The number of the object that the adjustment was applied to.

Depending on the type of transaction (sourceTransactionType value), this field will be a foreign key to either the invoice, payment, or refund table.

Reference:

sourceTransactionType
STRING

The source of the adjustment. Possible values are:

  • Invoice
  • Payment
  • Refund

status
STRING

The status of the adjustment. Possible values are:

  • Processed
  • Canceled

transferredToAccounting
STRING

The status of the adjustment being transferred to an external accounting system, such as NetSuite. Possible values are:

  • Processing
  • Yes
  • Error
  • Ignore

updatedById
STRING

The ID of the Zuora user who last updated the credit balance adjustment.

discountAppliedMetrics

Replication Method :

Key-based Incremental

 Replication Key :

updatedDate
Primary Key :

id

 Official docs :

Official Docs

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

discountAppliedMetrics table schema

id
STRING

The discount application ID.

updatedDate
DATE-TIME

The date when the discount application was last updated.

accountId
STRING

The ID of the account associated with the discount application.

Reference:

amendmentId
STRING

The ID of the subscription amendment associated with this record.

Reference:

billToContactId
STRING

The ID of the billing contact associated with the account to whom the product/service is billed.

Reference:

createdById
STRING

The ID of the Zuora user who created the discount application.

createdDate
DATE-TIME

The date when the discount application was created.

defaultPaymentMethodId
STRING

The default payment method the associated account uses to make payments.

Reference:

discountRatePlanChargeId
STRING

The ID of the Rate Plan Charge that represents the discount.

Reference:

mrr
STRING

The monthly recurring revenue associated with the account.

parentAccountId
STRING

The ID of the parent customer account for this account. This field is used when customer hierarchy is enabled in Zuora.

Reference:

productId
STRING

The ID of the product associated with the discount application.

Reference:

productRatePlanChargeId
STRING

The ID of the product rate plan charge associated with the discount application.

Reference:

productRatePlanId
STRING

The ID of the product rate plan associated with the discount application.

Reference:

ratePlanChargeId
STRING

The ID of the rate plan charge associated with the discount application.

Reference:

ratePlanId
STRING

The ID of the rate plan associated with the discount application.

Reference:

soldToContactId
STRING

The ID of the person who bought the subscription associated with the account.

Reference:

startDate
DATE-TIME

The earliest date that the discount applies.

subscriptionId
STRING

The ID of the subscription to which the rate plan is associated.

Reference:

tcv
STRING

The total contract value of the discount.

updatedById
STRING

The ID of the Zuora user who last updated the discount application.

export

Replication Method :

Key-based Incremental

 Replication Key :

updatedDate
Primary Key :

id

 Official docs :

Official Docs

The export table contains information about export jobs and files.

export table schema

id
STRING

The export ID.

updatedDate
DATE-TIME

The date when the export was last updated.

convertToCurrencies
STRING

The currencies that transaction amounts will be converted into.

createdById
STRING

The ID of the Zuora user who created the export.

createdDate
DATE-TIME

The date when the export was created.

deleted
BOOLEAN

Only supported for the AQuA API. If true, this record was deleted in Zuora.

encrypted
BOOLEAN

Indicates if encrypted data source fields (ex: paymentMethod.achAccountNumber) have had a secure version exported.

fileId
STRING

The ID of the file generated by the export query.

format
STRING

The format that the export file used. Possible values are:

  • csv
  • html
  • Excel

name
STRING

The name of the export.

query
STRING

Currently unsupported by the Zuora API.

size
INTEGER

The number of records or rows exported.

status
STRING

The status of the export. Possible values are:

  • Pending
  • Processing
  • Completed
  • Canceled
  • Failed

statusReason
STRING

The reason for the given status. Useful for troubleshooting export failures.

zip
BOOLEAN

If true, the export file will be compressed into a zip file.

updatedById
STRING

The ID of the Zuora user who last updated the export.

import

Replication Method :

Key-based Incremental

 Replication Key :

updatedDate
Primary Key :

id

 Official docs :

Official Docs

The import table contains information about content uploads.

import table schema

id
STRING

The import ID.

updatedDate
DATE-TIME

The date when the import was last updated.

createdById
STRING

The ID of the Zuora user who created the import.

createdDate
DATE-TIME

The date when the import was created.

deleted
BOOLEAN

Only supported for the AQuA API. If true, this record was deleted in Zuora.

importType
STRING

The type of item imported.

importedCount
INTEGER

The number of successfully imported records.

md5
STRING

A check to validate the import file’s integrity.

name
STRING

The name of the import.

originalResourceUrl
STRING

The URL of the import file.

resultResourceUrl
STRING

The URL for the import result file, which is a zipped CSV file.

status
STRING

The status of the import. Possible values are:

  • Pending
  • Processing
  • Completed
  • Canceled
  • Failed

statusReason
STRING

The reason for the given status. Useful for troubleshooting import failures.

totalCount
INTEGER

The number of records in the import file.

updatedById
STRING

The ID of the Zuora user who last updated the import.

invoice

Replication Method :

Key-based Incremental

 Replication Key :

updatedDate
Primary Key :

id

 Official docs :

Official Docs

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

invoice table schema

id
STRING

The invoice ID.

Reference:

updatedDate
DATE-TIME

The date when the invoice was last updated.

accountId
STRING

The account ID.

Reference:

adjustmentAccount
DOUBLE

The amount of the invoice adjustments associated with the invoice.

amount
DOUBLE

The sum of all charges and taxes associated with the invoice.

amountWithoutTax
DOUBLE

The sum of all charges associated with the invoice, excluding taxes.

autoPay
BOOLEAN

If true, invoices will be automatically picked up for processing in the corresponding payment run.

balance
DOUBLE

The remaining balance of the invoice after all payments, adjustments, and refunds are applied.

billRunId
STRING

The ID of the bill run associated with the invoice.

billToContactId
STRING

The ID of the person to bill for the invoice.

Reference:

billToContactSnapshotId
STRING

The ID of the Bill To contact snapshot.

Reference:

comments
STRING

Additional info related to the invoice that a Zuora user added to the invoice.

createdById
STRING

The user ID of the person who created the invoice.

createdDate
DATE-TIME

The date when the invoice was generated.

creditBalanceAdjustmentAmount
DOUBLE

The currency amount of the adjustment applied to the customer’s credit balance.

defaultPaymentMethodId
STRING

The ID of the default payment method for the account.

Reference:

deleted
BOOLEAN

Only supported for the AQuA API. If true, this record was deleted in Zuora.

dueDate
DATE-TIME

The date by which the payment for the invoice is due.

includesOneTime
BOOLEAN

If true, the invoice includes one-time charges.

includesRecurring
BOOLEAN

If true, the invoice contains recurring charges.

includesUsage
BOOLEAN

If true, the invoice contains usage charges.

invoiceDate
DATE-TIME

The date on which to generate the invoice.

invoiceNumber
STRING

The unique identification number for the invoice.

Reference:

lastEmailSentDate
DATE-TIME

The date when the invoice was last emailed.

parentAccountId
STRING

The ID of the parent customer account for this account. This field is used when customer hierarchy is enabled in Zuora.

Reference:

paymentAmount
DOUBLE

The amount of payments applied to the invoice.

postedBy
STRING

The user ID of the person who moved the invoice to Posted status.

postedDate
DATE-TIME

The date when the invoice was posted.

refundAmount
DOUBLE

The amount of a refund that was applied against an earlier payment on the invoice.

soldToContactId
STRING

The ID of the person who bought the subscription associated with the account.

Reference:

soldToContactSnapshotId
STRING

The ID of the Sold To contact snapshot.

Reference:

source
STRING

The source of the invoice.

sourceId
STRING

The ID of the value in the source field.

status
STRING

The status of the invoice in the system. This is not the status of the invoice payment, but the invoice itself.

Possible values are:

  • Draft
  • Posted
  • Canceled

targetDate
DATE-TIME

The date used to determine which charged are to be billed.

taxAmount
DOUBLE

The total amount of the taxes applied to the invoice.

taxExemptAmount
DOUBLE

The total amount of the invoice that is tax exempt.

transferredToAccounting
STRING

Indicates if the invoice was transferred to an external accounting system, such as NetSuite. Possible values are:

  • Processing
  • Yes
  • Error
  • Ignore

updatedById
STRING

The ID of the Zuora user who last updated the invoice.

invoiceItem

Replication Method :

Key-based Incremental

 Replication Key :

updatedDate
Primary Key :

id

 Official docs :

Official Docs

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

invoiceItem table schema

id
STRING

The ID of the invoice item.

Reference:

updatedDate
DATE-TIME

The date when the invoice item was last updated.

accountingCode
STRING

The accounting code for the items charged.

appliedToChargeNumber
STRING

The charge number that the discount charge is applied to. This is only applicable to invoice items that are discount charges.

appliedToInvoiceItemId
STRING

Associates a discount invoice item to a specific invoice item.

chargeAmount
DECIMAL

The amount being charged for the invoice item, without taxes.

chargeDate
DATE-TIME

The date when the invoice item was created.

chargeName
STRING

The name of the invoice item’s charge.

createdById
STRING

The ID of the Zuora user who created the invoice item.

createdDate
DATE-TIME

The date the invoice item was created.

deleted
BOOLEAN

Only supported for the AQuA API. If true, this record was deleted in Zuora.

invoiceId
STRING

The ID of the invoice associated with the invoice item.

Reference:

processingType
DECIMAL

The processing type of the invoice item. Possible values are:

  • 0 - charge
  • 1 - discount
  • 2 - prepayment
  • 3 tax

productDescription
STRING

The description of the product associated with the invoice item.

productId
STRING

The ID of the product associated with the invoice item.

Reference:

productRatePlanChargeId
STRING

The ID of the rate plan charge associated with the invoice item.

Reference:

quantity
DECIMAL

The number of units for the invoice item.

ratePlanChargeId
STRING

The ID of the rage plan charge that’s associated with the invoice item.

Reference:

revRecCode
STRING

Associates the invoice item with a specific revenue recognition code.

revRecStartDate
DATE-TIME

The date when revenue recognition is triggered.

revRecTriggerCondition
STRING

Specifies when revenue recognition begins based on a triggering event.

serviceEndDate
DATE-TIME

The end date of the service period associated with the invoice item. Service will end one second before the date in this value.

serviceStartDate
DATE-TIME

The start date of the service period associated with the invoice item.

sku
STRING

The unique SKU for the product associated with the invoice item.

subscriptionId
STRING

The ID of the subscription associated with the invoice item.

Reference:

taxAmaount
DOUBLE

The amount of tax applied to the invoice item’s charge.

taxCode
STRING

The tax code for taxation rules.

taxExemptAmount
DOUBLE

The amount of the invoice item’s charge that is tax exempt.

taxMode
STRING

The tax mode of the invoice item.

unitPrice
DOUBLE

The per-unit price of the invoice item.

uom
STRING

The units to measure usage.

updatedById
STRING

The ID of the Zuora user who last updated the invoice item.

invoiceItemAdjustment

Replication Method :

Key-based Incremental

 Replication Key :

updatedDate
Primary Key :

id

 Official docs :

Official Docs

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

invoiceItemAdjustment table schema

id
STRING

The ID of the adjustment.

updatedDate
DATE-TIME

The date when the adjustment was last updated.

accountId
STRING

The ID of the account associated with the adjustment.

Reference:

accountingCode
STRING

The accounting code for the invoice item.

Reference:

accountingPeriodId
STRING

The ID of the accounting period associated with the invoice.

Reference:

accountReceivableAccountingCodeId
STRING

The ID of the accounts receivable accounting code associated with the invoice.

Reference:

adjustmentDate
DATE-TIME

The date when the adjustment was applied.

adjustmentNumber
STRING

A unique identifier for the adjustment.

amendmentId
STRING

The ID of the amendment associated with the invoice item.

Reference:

amount
DOUBLE

The amount of the adjustment.

billToContactId
STRING

The ID of the person to bill for the account.

Reference:

cancelledById
STRING

The ID of the Zuora user who canceled the adjustment.

cancelledDate
DATE-TIME

The date when the adjustment was canceled.

comment
STRING

Comments about the adjustment.

createdById
STRING

The ID of the Zuora user who created the adjustment.

createdDate
DATE-TIME

The date the adjustment was created.

customerName
STRING

The name of the account that owns the associated invoice.

customerNumber
STRING

The unique account number of the customer’s account.

deleted
BOOLEAN

Only supported for the AQuA API. If true, this record was deleted in Zuora.

invoiceId
STRING

The ID of the invoice associated with the adjustment.

Reference:

invoiceItemName
STRING

The name of the invoice item’s charge.

invoiceNumber
STRING

The unique ID for the invoice that contains the invoice item.

Reference:

journalEntryId
STRING

The journal entry ID associated with the adjustment.

Reference:

journalRunId
STRING

The ID of the journal run associated with the adjustment.

Reference:

parentAccountId
STRING

The ID of the parent customer account for this account. This field is used when customer hierarchy is enabled in Zuora.

Reference:

productId
STRING

The ID of the product associated with the adjustment.

Reference:

productRatePlanChargeId
STRING

The ID of the rate plan charge associated with the adjustment.

Reference:

ratePlanChargeId
STRING

The ID of the rage plan charge that’s associated with the adjustment.

Reference:

ratePlanId
STRING

The ID of the rate plan associated with the adjustment.

Reference:

reasonCode
STRING

Associates the adjustment with a specific revenue recognition code.

recognizedRevenueAccountingCodeId
DATE-TIME

The ID of the accounting code used for recognized revenue.

Reference:

referenceId
STRING

A code to reference an object external to Zuora.

salesTaxPayableAccountingCodeId
STRING

The ID of the accounting code used for sales tax payable.

Reference:

serviceEndDate
DATE-TIME

The end date of the service period associated with the adjustment. Service will end one second before the date in this value.

serviceStartDate
DATE-TIME

The start date of the service period associated with the adjustment.

soldToContactId
STRING

The ID of the person who bought the subscription associated with the account.

Reference:

sourceId
STRING

The ID of the item specified in the sourceType field.

sourceType
STRING

The type of adjustment. Possible values are InvoiceDetail, Tax

status
STRING

The status of the invoice item adjustment. Possible values are:

  • Canceled
  • Processed

subscriptionId
STRING

The ID of the subscription associated with the adjustment.

Reference:

taxationItemId
STRING

The ID of the associated taxation record.

transferredToAccounting
STRING

Indicates if the adjustment has been transferred to an external accounting system. Possible values are:

  • Processing
  • Yes
  • Error
  • Ignore

updatedById
STRING

The ID of the Zuora user who last updated the adjustment.

journalEntry

Replication Method :

Key-based Incremental

 Replication Key :

updatedDate
Primary Key :

id

 Official docs :

Official Docs

The journalEntry table contains information about

journalEntry table schema

id
STRING

The journal entry ID.

updatedDate
DATE-TIME

The date when the journal entry was last updated.

accountingPeriodId
STRING

The ID of the accounting period associated with the journal entry.

createdById
STRING

The ID of the Zuora user who created the journal entry.

createdDate
DATE-TIME

The date when the journal entry was created.

currency
STRING

The currency the journal entry is in.

deleted
BOOLEAN

Only supported for the AQuA API. If true, this record was deleted in Zuora.

journalEntryDate
DATE-TIME

The date of the journal entry.

journalRunId
STRING

The ID of the journal run associated with the journal entry.

Reference:

notes
STRING

Additional info about the journal entry.

number
STRING

The number of the journal entry in the format JE-XXXXXXXX. For example: JE-00000001

status
STRING

The status of the journal entry. Possible values are:

  • Created
  • Cancelled

transferDate
DATE-TIME

The date that the value of transferredToAccounting changed to Yes. This field will be NULL otherwise.

transferredBy
STRING

The ID of the Zuora user who changed the value of transferredToAccounting to Yes. This field will be NULL otherwise.

journalEntryItem

Replication Method :

Key-based Incremental

 Replication Key :

updatedDate
Primary Key :

id

 Official docs :

Official Docs

The journalEntryItem table contains information about journal entry items.

journalEntryItem table schema

id
STRING

The journal entry item ID.

updatedDate
DATE-TIME

The date when the journal entry item was last updated.

accountingCodeId
STRING

The accounting code associated with the journal entry item.

accountingCodeType
STRING

The type of the accounting code associated with the journal entry item. Possible values are:

  • AccountsReceivable
  • On-Account Receivable
  • Cash
  • OtherAssets
  • CustomerCashOnAccount
  • DeferredRevenue
  • SalesTaxPayable
  • OtherLiabilities
  • SalesRevenue
  • SalesDiscounts
  • OtherRevenue
  • OtherEquity
  • BadDebt
  • OtherExpenses

amount
DOUBLE

The amount of the journal entry item in the transaction currency.

createdById
STRING

The ID of the Zuora user who created the journal entry item.

createdDate
DATE-TIME

The date when the journal entry item was created.

deleted
BOOLEAN

Only supported for the AQuA API. If true, this record was deleted in Zuora.

journalEntryId
STRING

The ID of the journal entry associated with the journal entry item.

Reference:

journalRunId
STRING

The ID of the journal run associated with the journal entry item.

Reference:

type
STRING

The type of journal entry item.

updatedById
STRING

The ID of the Zuora user who last updated the journal entry item.

journalRun

Replication Method :

Key-based Incremental

 Replication Key :

updatedDate
Primary Key :

id

 Official docs :

Official Docs

The journalRun table contains information about journal runs.