Available tables
This reference provides an overview of available tables in Data Query, differences between tenants, and methods to retrieve table lists using the SHOW TABLES statement and Data Query Schema Browser.
Depending on the available features in each tenant, the available tables in Data Query might be different between tenants. You can use the SHOW
TABLES
statement to retrieve a complete and exact list of the available tables. You can also use Data Query Schema Browser to view the full list of all available tables.
Each table corresponds to a Zuora object type, and most tables correspond to the base object of a Zuora data source.
The main difference between tables in Data Query and data sources is that tables in Data Query are not pre-joined to other tables. When you query a table in Data Query, you can arbitrarily join other tables to retrieve any data that you require. In the corresponding data source, Zuora has pre-joined the base object to a fixed set of related object types; you cannot retrieve data from other object types.
To learn how different object types relate to one another, see:
-
Zuora Business Object Model
-
Invoice Settlement Object Model
-
Orders Object Model
To get a complete and exact list of the available tables in your tenant, use SHOW TABLES
.
Table |
Each Row Represents |
Columns |
---|---|---|
|
A customer account |
Use |
Only available if you use Zuora Finance |
An accounting period |
Use |
|
An accounting code |
Use |
Not available if the Orders feature is enabled |
An amendment to a subscription |
Use |
Only available if the Invoice Settlement feature is enabled |
A group of payment, refund, and credit memo applications |
Use |
|
A billing run |
Use |
|
A charge metrics service for accessing the key metrics for Rate Plan Charges in Zuora. |
Use |
|
The discount allocation detail in the charge metrics |
Use |
|
A charge metrics record for accessing the TCB metric date of Rate Plan Charges. |
Use |
|
The discount allocation details for accessing the TCB metric data of Discount Rate Plan Charges. |
Use |
|
A payment run initiated in the Advanced Payment Manager feature |
Use |
|
An account that is in collection based on the system condition and the conditions you defined in the Collections Window feature |
Use |
|
A processing record of the configured lockbox file format in the Configurable Lockbox feature |
Use |
|
A file record of the configured lockbox file format in the Configurable Lockbox feature |
Use |
|
A lockbox file format configured in the Configurable Lockbox feature |
Use |
|
A payment record that has been completed or is in progress in the Configurable Lockbox feature |
Use |
|
A payment retry attempt initiated in the Configurable Payment Retry feature |
Use |
|
A customer group configured in the Configurable Payment Retry feature |
Use |
|
A record of the retry metics in the Configurable Payment Retry feature |
Use |
|
A retry cycle in the Configurable Payment Retry feature |
Use |
|
A user group in the Notes feature |
Use |
|
A note in the Notes feature |
Use |
|
A reply in the Notes feature |
Use |
|
A user in the Notes feature |
Use |
|
A contact person. For example, the Bill To contact of a customer account |
Use |
|
A copy of the Bill To or Sold To contact information from a posted invoice |
Use |
|
A country or region |
Use |
Deprecated if the Invoice Settlement feature is enabled |
An adjustment to the credit balance of a customer account |
Use |
Only available if the Invoice Settlement feature is enabled |
A credit memo that is owned by a customer account |
Use |
Only available if the Invoice Settlement feature is enabled |
A credit memo that is applied to an invoice or a debit memo |
Use |
Only available if the Invoice Settlement feature is enabled |
A credit memo that is applied to a line item in an invoice or a line item in a debit memo |
Use |
Only available if the Invoice Settlement feature is enabled |
A line item in a credit memo |
Use |
Only available if the Invoice Settlement feature is enabled |
An applied or unapplied portion of a credit memo |
Use |
Only available if the Invoice Settlement feature is enabled |
A portion of a credit memo that is applied to a line item in an invoice or a line item in a debit memo |
Use |
Only available if the Invoice Settlement feature is enabled |
A taxation line item in a credit memo |
Use |
Only available if the Invoice Settlement feature is enabled |
A debit memo that is owned by a customer account |
Use |
Only available if the Invoice Settlement feature is enabled |
A line item in a debit memo |
Use |
Only available if the Invoice Settlement feature is enabled |
A taxation line item in a debit memo |
Use |
|
A discount rate plan charge that is applied to another rate plan charge |
Use |
Only available if the Custom Foreign Currency Exchange Rates feature is enabled |
A custom exchange rate |
Use |
|
An invoice |
Use |
Deprecated |
An adjustment to an invoice |
Use |
|
A line item in an invoice |
Use |
Deprecated if the Invoice Settlement feature is enabled |
An adjustment to a line item in an invoice |
Use |
Deprecated if the Invoice Settlement feature is enabled |
A payment that is applied to an invoice |
Use |
Only available if you use Zuora Finance |
A journal entry |
Use |
Only available if you use Zuora Finance |
A line item in a journal entry |
Use |
Only available if you use Zuora Finance |
A journal run |
Use |
|
A callout notification history |
Use |
|
An email notification history |
Use |
|
An email-sending event, such as Bounced events, or Delivered events. Note that you can find events of a particular email history in this table only if this email was sent from the default email server or Advanced SMTP server.
|
Use |
Only available if the Order Metrics feature, the Orders feature, or the Orders Harmonization feature is enabled |
An order action that is applied to a subscription |
Use |
Only available if the Orders feature or the Orders Harmonization feature is enabled. Click the use case below to see a query sample. Query the rate plan added by the Add Product order action in an order |
A rate plan (in a subscription) that has been created or amended by a specific order action |
Use SHOW COLUMNS to list the available columns. |
Note:
The Order Line Items feature is now generally available. You need to enable the Orders or Orders Harmonization feature to access the Order Line Items feature. |
An order line item |
Use SHOW COLUMNS to list the available columns. |
Only available if the Order Metrics feature or the Orders feature is enabled Note: The following Order Metrics have been deprecated. Any new customers who onboard on Orders or Orders Harmonization will not get these metrics.
Existing Orders customers who have these metrics will continue to be supported. |
An "extended list price" metric for an order action |
Use |
Only available if the Order Metrics feature or the Orders feature is enabled Note: The following Order Metrics have been deprecated. Any new customers who onboard on Orders or Orders Harmonization will not get these metrics.
Existing Orders customers who have these metrics will continue to be supported. |
An order item |
Use |
Only available if the Order Metrics feature, the Orders feature, or the Orders Harmonization feature is enabled Note: The following Order Metrics have been deprecated. Any new customers who onboard on Orders or Orders Harmonization will not get these metrics.
Existing Orders customers who have these metrics will continue to be supported. |
A "monthly recurring revenue" metric for an order action |
Use |
Only available if the Order Metrics feature, the Orders feature, or the Orders Harmonization feature is enabled Note: The following Order Metrics have been deprecated. Any new customers who onboard on Orders or Orders Harmonization will not get these metrics.
Existing Orders customers who have these metrics will continue to be supported. |
A "quantity" metric for an order action |
Use |
Only available if the Order Metrics feature, the Orders feature, or the Orders Harmonization feature is enabled |
An order |
Use |
Only available if the Order Metrics feature, the Orders feature, or the Orders Harmonization feature is enabled Note: The following Order Metrics have been deprecated. Any new customers who onboard on Orders or Orders Harmonization will not get these metrics.
Existing Orders customers who have these metrics will continue to be supported. |
A "total contracted billing" metric for an order action |
Use |
Only available if the Order Metrics feature, the Orders feature, or the Orders Harmonization feature is enabled Note: The following Order Metrics have been deprecated. Any new customers who onboard on Orders or Orders Harmonization will not get these metrics.
Existing Orders customers who have these metrics will continue to be supported. |
A "total contract value" metric for an order action |
Use |
|
A payment |
Use |
Only available if the Invoice Settlement feature is enabled |
A payment that is applied to an invoice or a debit memo |
Use |
Only available if the Invoice Settlement feature is enabled |
A payment that is applied to a line item in an invoice or a line item in a debit memo |
Use |
|
An event that was processed by a payment reconciliation job |
Use |
|
A payment method |
Use |
|
A copy of the payment method that was used in a transaction |
Use |
|
A transaction from Zuora to the payment gateway associated with a payment method. If Zuora Fraud Protection is enabled, the record of data related to the fraud protection service is also included. |
Use |
Only available if the Invoice Settlement feature is enabled |
An applied or unapplied portion of a payment |
Use |
Only available if both Invoice Settlement and Invoice Item Settlement are enabled |
A portion of a payment that is applied to a line item in an invoice or a line item in a debit memo |
Use |
|
A payment reconciliation job |
Use |
|
A reconciled transaction that was processed by a payment reconciliation job |
Use |
|
A payment run |
Use |
|
A transaction from Zuora to the payment gateway associated with a payment. If Zuora Fraud Protection is enabled, the record of data related to the fraud protection service is also included. |
Use |
|
Uploaded usage that has been processed |
Use |
|
A product in your product catalog |
Use |
Only available if you use Entitlements |
A feature in your product catalog |
Use |
|
A rate plan in your product catalog |
Use |
|
A charge in your product catalog |
Use |
|
A charge tier in your product catalog |
Use |
|
A rate plan in a subscription |
Use |
|
A charge in a subscription |
Use |
|
A charge tier in a subscription |
Use |
|
A ramp in an order defined in a ramp deal |
Use |
|
A ramp interval in a ramp |
Use |
|
A refund |
Use |
Only available if the Invoice Settlement feature is enabled |
A refund that is applied to a payment or a credit memo |
Use |
Only available if the Invoice Settlement feature is enabled |
a refund that is applied to a line item in a credit memo |
Use |
Deprecated if the Invoice Settlement feature is enabled |
A refunded portion of a payment that is applied to an invoice |
Use |
Only available if the Invoice Settlement feature is enabled |
An applied or unapplied portion of a refund |
Use |
Only available if both Invoice Settlement and Invoice Item Settlement are enabled |
A portion of a refund that is applied to a line item in a credit memo |
Use |
|
A transaction from Zuora to the payment gateway associated with a payment |
Use |
Only available if you use Zuora Finance - Revenue |
A revenue distribution summary of a charge |
Use |
Only available if you use Zuora Finance - Revenue |
An item in a revenue distribution summary of a charge |
Use |
Only available if you use Zuora Finance - Revenue |
A revenue event |
Use |
Only available if you use Zuora Finance - Revenue and the Invoice Settlement feature is enabled |
A revenue event that is associated with a line item in a credit memo |
Use |
Only available if you use Zuora Finance - Revenue and the Invoice Settlement feature is enabled |
A revenue event that is associated with a line item in a debit memo |
Use |
Only available if you use Zuora Finance - Revenue |
A revenue event that is associated with a line item in an invoice |
Use |
Only available if you use Zuora Finance - Revenue |
A revenue event that is associated with an adjustment to a line item in an invoice |
Use |
Only available if you use Zuora Finance - Revenue |
A revenue event item |
Use |
Only available if you use Zuora Finance - Revenue and the Invoice Settlement feature is enabled |
A revenue event item that is associated with a line item in a credit memo |
Use |
Only available if you use Zuora Finance - Revenue and the Invoice Settlement feature is enabled |
A revenue event item that is associated with a line item in a debit memo |
Use |
Only available if you use Zuora Finance - Revenue |
A revenue event item that is associated with a line item in an invoice |
Use |
Only available if you use Zuora Finance - Revenue |
A revenue event item that is associated with an adjustment to a line item in an invoice |
Use |
Only available if you use Zuora Finance - Revenue |
A revenue event type |
Use |
Only available if you use Zuora Finance - Revenue |
A revenue schedule |
Use |
Only available if you use Zuora Finance - Revenue and the Invoice Settlement feature is enabled |
A revenue schedule that is associated with a line item in a credit memo |
Use |
Only available if you use Zuora Finance - Revenue and the Invoice Settlement feature is enabled |
A revenue schedule that is associated with a line item in a debit memo |
Use |
Only available if you use Zuora Finance - Revenue |
A revenue schedule that is associated with a line item in an invoice |
Use |
Only available if you use Zuora Finance - Revenue |
A revenue schedule that is associated with an adjustment to a line item in an invoice |
Use |
Only available if you use Zuora Finance - Revenue |
a revenue schedule item |
Use |
Only available if you use Zuora Finance - Revenue and the Invoice Settlement feature is enabled |
A revenue schedule item that is associated with a line item in a credit memo |
Use |
Only available if you use Zuora Finance - Revenue and the Invoice Settlement feature is enabled |
A revenue schedule item that is associated with a line item in a debit memo |
Use |
Only available if you use Zuora Finance - Revenue |
a revenue schedule item that is associated with a line item in an invoice |
Use |
Only available if you use Zuora Finance - Revenue |
A revenue schedule item that is associated with an adjustment to a line item in an invoice |
Use |
|
A subregion of a country or region |
Use |
|
A subscription |
Use |
|
The status history of a subscription |
Use |
Only available if the Taxable Item Snapshot feature is enabled |
A copy of information that was used in a tax calculation |
Use |
|
A taxation line item in an invoice |
Use |
|
A batch of payment methods that was sent to a payment method updater service provider |
Use |
|
A payment method update |
Use |
|
A usage record If the Active Rating feature is enabled, Each row represents a usage record that was created via the Active Rating feature |
Use |
Only platform admin users can access the |
A user in your Zuora tenant |
|
|
A workflow version or a workflow run. |
Use |
|
An API call made during a workflow run. |
Use |
|
A connection between two tasks in a workflow version. |
Use |
|
A task that is part of a workflow version or a workflow run. |
Use |
|
Your entity's usage of Workflow over a single day. |
Use |
|
A workflow definition that has at least one workflow version. |
Use |
|
The information of a file attached to a Zuora object. You can now query the attachment file information of the following Zuora objects:
|
Use |
By default, all UUIDs are handled as 32-character strings. To enable 36-character UUIDs, submit a request at Zuora Global Support.
Function |
Description |
---|---|
|
Converts a 36-character object identifier to a 32-character object identifier. Newer Zuora features such as Data Query and the Active Rating feature use 36-character object identifiers, while older features use 32-character object identifiers. For example:
Returns:
See the "Examples" section below for a sample query that uses the
|
|
Converts a 32-character object identifier to a 36-character object identifier. Newer Zuora features such as Data Query and the Active Rating feature use 36-character object identifiers, while older features use 32-character object identifiers. For example:
Returns:
See the "Examples" section below for a sample query that uses the
|
Get the date value of a timestamp
date
function. The syntax of this function is as follows:date(<timestamp>)
date(<timestamp> AT TIME ZONE <timezone>)
The
date
function takes the
timestamp
parameter and returns a date value. The
timestamp
parameter is required. You can get the date in a particular time zone by specifying a
timezone
after the
timestamp
.
Function expression |
Result |
Description |
---|---|---|
date(CURRENT_TIMESTAMP) |
2023-01-12 |
Returns the date of current UTC. |
date(CURRENT_TIMESTAMP AT TIME ZONE '-08:00') |
2023-01-11 |
Returns the date of current UTC in UTC-08:00 time zone. |
date(CURRENT_TIMESTAMP AT TIME ZONE 'America/Los_Angeles') |
2023-01-11 |
Returns the date of current UTC in Los Angeles time zone (UTC-07:00 or UTC-08:00 depending on the time of the year). |
date(timestamp '2022-12-30 13:30:00') |
2022-12-30 |
Returns the date of 2022-12-30 13:30:00 UTC. |
date(timestamp '2022-12-30 13:30:00 -08:00') |
2022-12-30 |
Returns the date of 2022-12-30 13:30:00 UTC-08:00. |
date(timestamp '2022-12-30 13:30:00 -08:00' AT TIME ZONE 'UTC') |
2022-12-30 |
Returns the date of 2022-12-30 13:30:00 UTC-08:00 in UTC time zone. |
date(timestamp '2022-12-30 13:30:00 -08:00' AT TIME ZONE '+08:00') |
2022-12-31 |
Returns the date of 2022-12-30 13:30:00 UTC-08:00 in UTC+08:00 time zone. |
For more information about how to use the date function in queries, see Best-practice samples for common queries.