Knowledge Center

Knowledge Center > API > Export ZOQL

Export ZOQL

Zuora Export ZOQL (Zuora Object Query Language) is the query language used to create Exports with the Export object in the Zuora SOAP and REST APIs. Zuora Export ZOQL is similar to our general ZOQL, with a few differences. The biggest difference is that with Exports, you query a Zuora data source, not a SOAP API object.

Zuora Data Sources

A Zuora data source is a SOAP object pre-joined with other related objects. For example, the Account data source includes all of the fields associated with the account object, and also the fields from additional related objects such as, the bill-to contact, sold-to contact, and default payment method. This allows your query to include data from related objects in a single operation, convenient for reporting, business intelligence, and other applications that might otherwise require a multi-step operation to capture related data. Data sources save you the effort of constructing nested queries, and result in fewer round-trips and faster performance.

For example, when you query subscriptions through the Subscription data source, you also get the related accounts, bill-to contacts, sold-to contacts, and default payment methods.

View Data Source Fields and Values

To view all field and field values for any data source, you can use the Zuora REST API URL:

https://www.zuora.com/apps/api/describe/<datasource>

Where <datasource> is the name of the data source such as: Account, RatePlanCharge, InvoiceItem, or another data source name.  You must specify your Zuora credentials using Basic Authentication or by setting a cookie with a valid Zuora Session ID. See Creating an Export for additional details.

For example, the following URL will return an XML description of the RatePlan data source:

https://www.zuora.com/apps/api/describe/RatePlan

Although any base object in the Z-Commerce API is also a data source, not every data source offers additional pre-joined objects. For example, the PaymentMethod data source does not have any additional objects joined to it. Because of this, the PaymentMethod data source is equivalent to the PaymentMethod Z-Object.

The ../describe/<datasource> call reveals all the data source field attributes.  If a data source field has a context attribute value of "soap", <context>soap</context>, then the field may be queried using SOAP, and if the data source field has a context attribute value of "export" then the field may be retrieved using export ZOQL.  Many field attributes may be retrieved using either query method.

Field Values in Data Sources

Each Export ZOQL data source includes all the fields of the base and joined SOAP API objects.

Prior to version 79 of the Zuora WSDL, some fields in Export ZOQL data sources had different values from the corresponding SOAP API fields. See Field Values in Export ZOQL Data Sources for more information.

Limitations

Characters per Data Source Query

20,000 characters are allowed in a data source ZOQL query.

File Size

The maximum export file size is 2047MB. If you have large data requests that go over this limit, you will get the following 403 HTTP response code from Zuora:
  <security:max-object-size>2047MB</security:max-object-size>

Submit a request at Zuora Global Support if you require additional assistance.

We can work with you to determine if large file optimization is an option for you.

Data Sources and Objects

The following table lists the data sources, their the base objects and the pre-joined objects. The object names are specified via the Zuora API names, and the base objects have links to the corresponding SOAP objects.

Data Source Base Object Pre-joined Objects 
Account Account
  • BillToContact
  • DefaultPaymentMethod
  • ParentAccount
  • SoldToContact
Accounting Code AccountingCode None

Billing Run

BillRun None
Contact Contact None
Credit Balance Adjustment
(Credit Balance Permission Enabled)
CreditBalanceAdjustment
  • Account
  • AccountingPeriod (Z-FInance)
  • AccountReceivableAccountingCode
  • BillToContact
  • CashAccountingCode
  • CustomerCashOnAccountAccountingCode
  • DefaultPaymentMethod
  • Invoice
  • JournalEntry (Z-Finance)
  • JournalRun (Z-Finance)
  • ParentAccount
  • Payment
  • PaymentMethod
  • PaymentMethodSnapShot
  • Refund
  • SoldToContact
Payment Gateway
Reconciliation Event Log
PaymentGateway
ReconciliationEventLog
  • PaymentReconciliationJob
Payment Reconciliation Log PaymentReconciliationLog
  • PaymentGatewayReconciliationEventLog
  • PaymentReconciliationJob
Invoice Invoice
  • Account
  • BillToContact
  • DefaultPaymentMethod
  • ParentAccount
  • SoldToContact
Invoice Adjustment InvoiceAdjustment
  • Account
  • AccountingPeriod (Z-Finance)
  • AccountReceivableAccountingCode
  • BillToContact
  • DefaultPaymentMethod
  • DeferredRevenueAccountingCode
  • Invoice
  • JournalEntry (Z-Finance)
  • JournalRun (Z-Finance)
  • ParentAccount
  • SoldToContact
Invoice Item InvoiceItem
  • Account
  • AccountingPeriod (Z-Finance)
  • AccountReceivableAccountingCode
  • Amendment
  • BillToContact
  • DefaultPaymentMethod
  • DeferredRevenueAccountingCode
  • Invoice
  • JournalEntry (Z-Finance)
  • JournalRun (Z-Finance)
  • ParentAccount
  • Product
  • ProductRatePlan
  • ProductRatePlanCharge
  • RatePlan
  • RatePlanCharge
  • RecognizedRevenueAccountingCode
  • SoldToContact
  • Subscription
Invoice Item Adjustment InvoiceItemAdjustment
  • Account
  • AccountingPeriod (Z-Finance)
  • AccountReceivableAccountingCode
  • Amendment
  • BillToContact
  • DefaultPaymentMethod
  • DeferredRevenueAccountingCode
  • Invoice
  • InvoiceItem
  • JournalEntry (Z-Finance)
  • JournalRun (Z-Finance)
  • ParentAccount
  • Product
  • Product Rate Plan
  • Product Rate Plan Charge
  • Rate Plan
  • Rate Plan Charge
  • RecognizedRevenueAccountingCode
  • SalesTaxPayableAccountingCode
  • SoldToContact
  • Subscription
  • TaxationItem
    (New with R165 / WSDL 48.0 in June 2013)
Invoice Payment InvoicePayment
  • Account
  • AccountingPeriod (Z-Finance)
  • AccountReceivableAccountingCode
  • BillToContact
  • CashAccountingCode
  • DefaultPaymentMethod
  • Invoice
  • JournalEntry (Z-Finance)
  • JournalRun (Z-Finance)
  • ParentAccount
  • Payment
  • PaymentMethod
  • PaymentMethodSnapshot
  • SoldToContact

Journal Entry Item

(Z-Finance Enabled; SOAP API version 55.0+)

JournalEntryItem
  • AccountingCode
  • AccountingPeriod
  • JournalEntry
  • JournalRun
Payment Payment
  • Account
  • BillToContact
  • DefaultPaymentMethod
  • ParentAccount
  • PaymentMethod
  • PaymentMethodSnapshot
  • SoldToContact
Payment Method PaymentMethod None
Payment Method Transaction Log PaymentMethod
TransactionLog
  • Account
  • BillToContact
  • DefaultPaymentMethod
  • ParentAccount
  • PaymentMethod
  • SoldToContact
Payment Transaction Log PaymentTransactionLog
  • Account
  • BillToContact
  • DefaultPaymentMethod
  • ParentAccount
  • Payment
  • PaymentMethod
  • PaymentMethodSnapshot
  • SoldToContact
Processed Usage ProcessedUsage
  • Account
  • Amendment
  • BillToContact
  • DefaultPaymentMethod
  • Invoice
  • InvoiceItem
  • ParentAccount
  • Product
  • ProductRatePlan
  • ProductRatePlanCharge
  • RatePlan
  • RatePlanCharge
  • SoldToContact
  • Subscription
  • Usage
Product Product None
Product Rate Plan Charge ProductRatePlanCharge
  • AccountReceivableAccountingCode
  • DeferredRevenueAccountingCode
  • Product
  • ProductRatePlan
  • RecognizedRevenueAccountingCode
Product Rate Plan Charge Tier ProductRatePlanChargeTier
  • Product
  • ProductRatePlan
  • ProductRatePlanCharge
Rate Plan RatePlan
  • Account
  • Amendment
  • BillToContact
  • DefaultPaymentMethod
  • ParentAccount
  • Product
  • ProductRatePlan
  • SoldToContact
  • Subscription
  • SubscriptionVersionAmendment
Rate Plan Charge RatePlanCharge
  • Account
  • AccountReceivableAccountingCode
  • Amendment
  • BillToContact
  • DefaultPaymentMethod
  • DeferredRevenueAccountingCode
  • ParentAccount
  • Product
  • ProductRatePlan
  • ProductRatePlanCharge
  • RatePlan
  • RecognizedRevenueAccountingCode
  • SoldToContact
  • Subscription
Rate Plan Charge Tier RatePlanChargeTier
  • Amendment
  • Product
  • ProductRatePlan
  • ProductRatePlanCharge
  • RatePlan
  • RatePlanCharge
  • Subscription
Refund Refund
  • Account
  • BillToContact
  • DefaultPaymentMethod
  • ParentAccount
  • PaymentMethodSnapshot
  • SoldToContact
Refund Invoice Payment RefundInvoicePayment
  • Account
  • AccountingPeriod (Z-FInance)
  • AccountReceivableAccountingCode
  • BillToContact
  • CashAccountingCode
  • DefaultPaymentMethod
  • Invoice
  • InvoicePayment
  • JournalEntry (Z-Finance)
  • JournalRun (Z-Finance)
  • ParentAccount
  • Payment
  • PaymentMethod
  • PaymentMethodSnapshot
  • Refund
  • SoldToContact
Refund Transaction Log RefundTransactionLog
  • PaymentMethodSnapshot
  • Refund

Revenue Charge Summary Item

(Z-Finance Enabled)

RevenueCharge
SummaryItem
  • Account
  • AccountingPeriod
  • Amendment
  • BillToContact
  • DefaultPaymentMethod
  • ParentAccount
  • Product
  • ProductRatePlan
  • ProductRatePlanCharge
  • RatePlan
  • RatePlanCharge
  • RevenueChargeSummary
  • SoldToContact
  • Subscription

Revenue Event Item

(Z-Finance Enabled)

RevenueEventItem
  • Account
  • AccountingPeriod
  • Amendment
  • BillToContact
  • DefaultPaymentMethod
  • DeferredRevenueAccountingCode
  • JournalEntry
  • JournalRun
  • ParentAccount
  • Product
  • ProductRatePlan
  • ProductRatePlanCharge
  • RatePlan
  • RatePlanCharge
  • RecognizedRevenueAccountingCode
  • RevenueChargeSummary
  • RevenueEvent
  • RevenueEventType
  • RevenueSchedule
  • SoldToContact
  • Subscription

Revenue Event Item Invoice Item

(Z-Finance Enabled)

RevenueEventItem
InvoiceItem
  • Account
  • AccountingPeriod
  • Amendment
  • BillToContact
  • DefaultPaymentMethod
  • DeferredRevenueAccountingCode
  • Invoice
  • InvoiceItem
  • JournalEntry
  • JournalRun
  • ParentAccount
  • Product
  • ProductRatePlan
  • ProductRatePlanCharge
  • RatePlan
  • RatePlanCharge
  • RecognizedRevenueAccountingCode
  • RevenueChargeSummary
  • RevenueEventInvoiceItem
  • RevenueEventType
  • RevenueScheduleInvoiceItem
  • SoldToContact
  • Subscription

Revenue Event Item
Invoice Item Adjustment

(Z-Finance Enabled)

RevenueEventItem
InvoiceItem
  • Account
  • AccountingPeriod
  • Amendment
  • BillToContact
  • DefaultPaymentMethod
  • DeferredRevenueAccountingCode
  • Invoice
  • InvoiceItem
  • InvoiceItemAdjustment
  • JournalEntry 
  • JournalRun
  • ParentAccount
  • Product
  • ProductRatePlan
  • ProductRatePlanCharge
  • RatePlan
  • RatePlanCharge
  • RecognizedRevenueAccountingCode
  • RevenueChargeSummary
  • RevenueEventInvoiceItemAdjustment
  • RevenueEventType
  • RevenueScheduleInvoiceItemAdjustment
  • SoldToContact
  • Subscription

Revenue Schedule Item

(Z-Finance Enabled)

RevenueEventItem
InvoiceItem
  • Account
  • AccountingPeriod
  • Amendment
  • BillToContact
  • DefaultPaymentMethod
  • DeferredRevenueAccountingCode
  • ParentAccount
  • Product
  • ProductRatePlan
  • ProductRatePlanCharge
  • RatePlan
  • RatePlanCharge
  • RecognizedRevenueAccountingCode
  • RevenueChargeSummary
  • RevenueSchedule
  • SoldToContact
  • Subscription

Revenue Schedule Item
InvoiceI tem

(Z-Finance Enabled)

RevenueScheduleItem
InvoiceItem
  • Account
  • AccountingPeriod
  • Amendment
  • BillToContact
  • DefaultPaymentMethod
  • DeferredRevenueAccountingCode
  • Invoice
  • InvoiceItem
  • ParentAccount
  • Product
  • ProductRatePlan
  • ProductRatePlanCharge
  • RatePlan
  • RatePlanCharge
  • RecognizedRevenueAccountingCode
  • RevenueChargeSummary
  • RevenueScheduleInvoiceItem
  • SoldToContact
  • Subscription

Revenue Schedule Item
InvoiceItem Adjustment

(Z-Finance Enabled)

RevenueScheduleItem
InvoiceItemAdjustment
  • Account
  • AccountingPeriod
  • Amendment
  • BillToContact
  • DefaultPaymentMethod
  • DeferredRevenueAccountingCode
  • Invoice
  • InvoiceItem
  • InvoiceItemAdjustment
  • ParentAccount
  • Product
  • ProductRatePlan
  • ProductRatePlanCharge
  • RatePlan
  • RatePlanCharge
  • RecognizedRevenueAccountingCode
  • RevenueChargeSummary
  • RevenueScheduleInvoiceItemAdjustment
  • SoldToContact
  • Subscription
Subscription Subscription
  • Account
  • BillToContact
  • DefaultPaymentMethod
  • ParentAccount
  • SoldToContact
  • SubscriptionVersionAmendment

Taxation Item

TaxationItem
  • Account
  • AccountingPeriod (Z-Finance)
  • AccountReceivableAccountingCode
  • Amendment
  • BillToContact
  • DefaultPaymentMethod
  • Invoice
  • InvoiceItem
  • JournalEntry (Z-Finance)
  • JournalRun (Z-Finance)
  • ParentAccount
  • Product
  • ProductRatePlan
  • ProductRatePlanCharge
  • RatePlan
  • RatePlanCharge
  • SalesTaxPayableAccountingCode
  • SoldToContact
  • Subscription
Payment Method Updater UpdaterDetail
  • NewPaymentMethod
  • PaymentMethod
  • UpdaterBatch
Usage Usage
  • Account
  • Amendment
  • BillToContact
  • DeferredPaymentMethod
  • ParentAccount
  • Product
  • ProductRatePlan
  • ProductRatePlanCharge
  • RatePlan
  • RatePlanCharge
  • SoldToContact
  • Subscription
Last modified
15:13, 27 Feb 2017

Tags

Classifications

(not set)