Welcome to Zuora Product Documentation

Explore our rich library of product information

Field descriptions

This reference lists the description of the fields of the Import object.

All field names are case sensitive. Check enumerated values in descriptions to confirm capitalization and spacing.

Name

Required to create?

Allowed operations

Description

CreatedById

optional

Query Filter

The user ID of the person who created the import.

Type : zns:ID

Character limit : 32

Version notes : WSDL 37.0+

Values : automatically generated

CreatedDate

optional

Query Filter

The date when the import was created.

Type : dateTime

Character limit : 29

Version notes : WSDL 37.0+

Values : automatically generated

FileContent

required

Create

A Base 64-encoded file that contains the contents of the import.

Type : DataHandler

Character limit : n/a

Version notes : WSDL 37.0+

Values : Base64-encoded file

Id

optional

Query Filter

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

Type : zns:ID

Character limit : 32

Version notes : WSDL 37.0+

Values : automatically generated

ImportedCount

optional

Query Filter

The number of records successfully imported.

Type : int

Character limit :

Version notes : WSDL 37.0+

Values : automatically generated

ImportType

required

Create Query Filter

The type of item imported.

Type : string (enum)

Character limit :

Version notes : WSDL 37.0

Values : One of the following values:

  • usage

  • payment

  • quote

  • taxationDetail

  • updateAccountingCode

  • createRevenueSchedule

  • updateRevenueSchedule

  • deleteRevenueSchedule

  • importFXRate

Md5

optional

Create Query Filter

A check to validate the import file's integrity.

Type : string

Character limi t: 32

Version notes : WSDL 37.0+

System-generated : no

Values : a string of 32 characters or fewer

Name

required

Create Query Filter

A descriptive name for the import.

Type : string

Character limi t: 100

Version notes : WSDL 37.0+

Values : one of the following:

  • a string of 100 characters or fewer

  • if NULL default is: import <ImportType_value>

OriginalResourceUrl

optional

Query Filter

The URL for your import file, which contains your records for upload. When you upload the file, Zuora assigns it to this address.

Type : string

Character limit :

Version notes : WSDL 37.0+

Values : automatic dynamically-generated URL

ResultResourceUrl

optional

Query Filter

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

Type : string

Character limit :

Version notes : WSDL 37.0+

Values : automatic dynamically-generated URL

Status

optional

Query Filter

The status of the import process.

Type : string (enum)

Character limit : 10

Version notes : WSDL 37.0+

Values : automatically generated using one of the following values:

  • Pending

  • Processing

  • Completed

  • Failed

StatusReason

optional

Query Filter

The reason for the system-generated status. Use this information if the import fails.

Type: string

Character limit : 2000

Version notes : WSDL 37.0+

Values : automatically generated error message

TotalCount

optional

Query Filter

The number of records in the import file.

Type : int

Character limit :

Version notes : WSDL 37.0+

Values : automatically generated

UpdatedById

optional

Query Filter

The ID of the user who last updated the import.

Type : zns:ID

Character limit : 32

Version notes : WSDL 37.0+

Values : automatically generated

UpdatedDate

optional

Query Filter

The date when the import was last updated.

Type : dateTime

Character limi t: 29

Version notes : WSDL 37.0+

Values : automatically generated