Knowledge Center

Knowledge Center > API > SOAP API > SOAP API Object Reference > Export

Export

You can export items from Zuora to CSV or HTML files, such as large data sets, invoices, payments, etc. Use the Export object and Export ZOQL queries to create an export file that you can download and use for charting, reporting, accounting, or for other business intelligence uses.

When you export data from Zuora, each exported file is available for download for seven days.

Usage

Supported Calls

You can use this object with the following calls:

Walkthroughs and Use Cases

Here are some common ways to use this object:

  • Export objects that are joined with other objects.
  • Export large data sets.

Basic Workflow

The following steps are the basic workflow for exporting data:

  1. Define your data set by selecting the relevant fields.
  2. Use create() Export to pass your query to Zuora.
  3. Zuora processes your request asynchronously. Typically, this process takes a few minutes to complete.
  4. Query Zuora for the status of your request.
  5. Once the status of the export is completed, use the REST API to download the export.

File Size Limitations

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.

Field Descriptions

All field names are case sensitive. Check enumerated values in descriptions to confirm capitalization and spacing. See Field Types for additional information.

Name Required to Create? Allowed Operations Description
CreatedById optional

Query
Filter

The user ID of the person who created the export.

Type: zns:ID

Character limit: 32

Version notes: --

Values: automatically generated

CreatedDate optional

Query
Filter

The date when the import was created.

Type: dateTime

Character limit: 29

Version notes: --

Values: automatically generated

Encrypted optional Create
Query
Filter

Exports a secure version of encrypted data source fields. such as the AchAccountNumber field of the PaymentMethod object and the DefaultPaymentMethod data souce objects.

Type: boolean

Character limit: 5

Version notes: WSDL 32.0

Values: true, false

FileId optional Create
Query
Filter

The ID of the file generated by an export query. This fiel is automatically generated when an Export object is created. Use this file ID when you download the export file.

Type: zns:ID

Character limit: 32

Version notes: --

Values: automatically generated

Format required Create
Query
Filter

The format that you want the export file to use.

Type: string (enum)

Character limit: 4

Version notes: --

Values: csv, html

Id optional Query
Filter

The ID of this object. Upon creation, the ID for this object is Export.Id.

Type: zns:ID

Character limit: 32

Version notes: --

Values: automatically generated

Name optional Create
Query
Filter

The name of the export.

Type: string

Character limit: 255

Version notes: --

Values: a string of 255 characters or fewer

Query required

Create
Query

The query of the export's fields. Remember that Export ZOQL differs from standard ZOQL. See Export ZOQL for more information.

Type: string

Character limit

Version notes: --

Values: a valid export ZOQL query string

ConvertToCurrencies

optional

Create
Query
Filter

The currencies that you want to convert transaction amounts into. You can specify any number of currencies. Specify the currencies using their ISO currency codes and separate each currency with a comma, for example, "EUR,GBP,JPY".

See Convert Transaction Amounts Into Any Currency for more information and examples.

You must have Foreign Currency Conversion enabled to use this field.

Type: string

Character limit

Version notes: WSDL 78+

Values: a list of valid currency codes

Size optional Create
Query
Filter

The number of records or rows exported. This field value is null until the export status is Completed.

Type: int

Character limit

Version notes: --

Values: automatically generated

Status optional Create
Query
Filter

The status of the export.

Type: string (enum)

Character limit: 10

Version notes: --

Values: automatically generated to be one of the following values:

  • Pending
  • Processing
  • Completed
  • Canceled
  • Failed
StatusReason optional Create
Query
Filter

The reason for the given status. Use this information to help ascertain why an export failed.

Type: string

Character limit: 255

Version notes: --

Values: automatically generated

UpdatedDate optional

Query
Filter

The date when the expotr was last updated.

Type: dateTime

Character limit: 29

Version notes: --

Values: automatically generated

UpdatedById optional

Query
Filter

The ID of the user who last updated the export.

Type: zns:ID

Character limit: 32

Version notes: --

Values: automatically generated

Zip optional Create
Query
Filter

Indicates if you want the resulting export file to be compressed into a zip file.

Type: boolean

Character limit

Version notes: --

Values: true, false (default)

Additional Field Detail

Encrypted

Exports a secure version of encrypted data source fields. such as the AchAccountNumber field of the PaymentMethod object and the DefaultPaymentMethod data souce objects.

To use this feature, set the Encrypted field value to true when you create an Export object.

Values: true, false

This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support

Id

The ID of this object. Every object has a unique identifier that Zuora automatically assigns upon creation. You use this ID later when you work with the object. For example, if you send a query() call to query the import, then you need to include the specific Export object's ID with the call.

The ID for the Export object is ExportId.

Last modified
16:25, 10 Oct 2016

Tags

Classifications

(not set)