Zuora is the leader in online recurring billing and payment solutions for SaaS and subscription businesses.

This connector provides access to the Z-Commerce platform API.

Additional Info

Requires Mule Enterprise License

Yes  

Requires Entitlement

No  

Mule Version

3.7.0 or higher

Configs

Configuration

<zuora:config>

Connection Management

Attributes

Name Java Type Description Default Value Required

name

String

The name of this configuration. With this name can be later referenced.

x 

username

String

x 

password

String

x 

readTimeout

Integer

Specifies the amount of time, in milliseconds, that the consumer will wait for a response before it times out. Default value is 0, which means infinite.

0

 

connectionTimeout

Integer

Specifies the amount of time, in milliseconds, that the consumer will attempt to establish a connection before it times out. Default value is 0, which means infinite.

0

 

wsdlLocation

String

Specifies the location of the Zuora Wsdl

 

endpoint

String

Endpoint to call when executing the operations

https://apisandbox.zuora.com/apps/services/a/75.0

 

restEndpoint

String

Endpoint to call REST Operations. Can be https://apisandbox.zuora.com/apps/api/ or https://www.zuora.com/apps/api/

https://apisandbox.zuora.com/apps/api/

 

Processors

Invoke SOAP Service

<zuora:invoke-soap-service>

  DataSense enabled

Calls SOAP based operations from THE Zuora WSDL.

XML Sample

<zuora:invoke config-ref="Zuora__Basic_Authentication" soapMetadataKey="metadata key" doc:name="Zuora"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

soapMetadataKey

String

the metadata Key that is used to extract useful information for executing the operation request

x 

input

XMLStreamReader

XMLStreamReader that represents the input of the operation

#[payload]

 

Returns

Return Java Type Description

XMLStreamReader

XMLStreamReader that represents the result of the operation

Get export file stream

<zuora:get-export-file-stream>

Retrieve an exported file from Zuora and return an InputStream to it

XML Sample

<zuora:get-export-file-stream config-ref="Zuora__Basic_Authentication"  exportId="id" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

exportId

String

id of the Zuora exported file to retrieve

#[payload]

 

entityId

String

optional parameter if the Zuora customer has multiple entities (either entityId or entityName must be specified)

 

entityName

String

optional parameter if Zuora customer has multiple entities (either entityId or entityName must be specified)

 

Returns

Return Java Type Description

InputStream

an InputStream to read from the exported file

Get export file content

<zuora:get-export-file-content>

Retrieve an exported file from Zuora, and return its content as a String

XML Sample

<zuora:get-export-file-content config-ref="Zuora__Basic_Authentication"  exportId="id" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

exportId

String

id of the Zuora exported file to retrieve

#[payload]

 

entityId

String

optional parameter if the Zuora customer has multiple entities (either entityId or entityName must be specified)

 

entityName

String

optional parameter if Zuora customer has multiple entities (either entityId or entityName must be specified)

 

Returns

Return Java Type Description

String

the file's content as a String

Query

<zuora:query>

  Paged Operation

Lazily retrieves ZObjects that match a given query, written in Zuora native query language. If you expect more than 2000 results to be returned, remember that you have to enable queryMore for your zuora account (as documented: http://knowledgecenter.zuora.com/D_Using_the_Zuora_API/C_API_Reference/E_API_Calls/queryMore())

XML Sample

<zuora:query config-ref="Zuora__Configuration" query="dsql:SELECT Name FROM Product" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

query

String

the query, using the SQL-Like Zuora Query Language

x 

pagingConfiguration

PagingConfiguration

the paging configuration

x 

Returns

Return Java Type Description

ProviderAwarePagingDelegate<Map<String,Object>,ZuoraConnector>

An array of Zobjects

Aqua post query

<zuora:aqua-post-query>

Submits an aggregated list of ZOQL and Export ZOQL queries. see postQuery()

XML Sample

<zuora:aqua-post-query config-ref="Zuora__Configuration"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

request

PostQueryRequest

the PostQuery request object

#[payload]

 

saveJobToObjectStore

boolean

flag that determines if the result should be saved in the object store

false

 

storeName

String

name for a PartitionedPersistentObjectStore

 

entityId

String

optional parameter if the Zuora customer has multiple entities (either entityId or entityName must be specified)

 

entityName

String

optional parameter if Zuora customer has multiple entities (either entityId or entityName must be specified)

 

Returns

Return Java Type Description

PostQueryResponse

PostQueryResponse the response of the PostQuery call.

Post usage

<zuora:post-usage>

Post or imports usage data for one or more accounts in the CSV format. see postUsage()

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

fileLocation

String

the location of the csv file to import

#[payload]

 

entityId

String

optional parameter if the Zuora customer has multiple entities (either entityId or entityName must be specified)

 

entityName

String

optional parameter if Zuora customer has multiple entities (either entityId or entityName must be specified)

 

Returns

Return Java Type Description

PostUsageResponse

PostUsageResponse the response of the PostUsage call. In order to check if the import is completed succesfully, the URL from checkImportStatus field must be called.

Check import status

<zuora:check-import-status>

Checks the status of the import made with the Post Usage operation. see postUsage()

XML Sample

<zuora:check-import-status config-ref="Zuora__Configuration" importUrl="url"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

importUrl

String

the url returned by the postUsage operation. When called, it returns the current status of the import.

#[payload]

 

entityId

String

optional parameter if the Zuora customer has multiple entities (either entityId or entityName must be specified)

 

entityName

String

optional parameter if Zuora customer has multiple entities (either entityId or entityName must be specified)

 

Returns

Return Java Type Description

ImportResponse

ImportStatus the response of the check import call.

Aqua get job results

<zuora:aqua-get-job-results>

Retrieves an aggregate query using the Job ID. see aquaGetJobResults()

XML Sample

<zuora:aqua-get-job-results config-ref="Zuora__Configuration"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

jobId

String

the job ID

#[payload]

 

entityId

String

optional parameter if the Zuora customer has multiple entities (either entityId or entityName must be specified)

 

entityName

String

optional parameter if Zuora customer has multiple entities (either entityId or entityName must be specified)

 

Returns

Return Java Type Description

Job

GetJobIdResponse object response.

Aqua get last completed job

<zuora:aqua-get-last-completed-job>

This operation returns the details of the last completed job. see aquaGetLastCompletedJob()

XML Sample

<zuora:aqua-get-last-completed-job config-ref="Zuora__Configuration"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

request

GetLastJobRequest

containing the partner field and projectId The partner field indicates the unique ID of a data integration partner. It must be used together with "projectId" parameter to uniquely identify a data integration target. The projectId is the unique ID of a data integration project for a particular partner. This parameter must be used together with partnerId field to uniquely identify a data integration target. This parameter is required only if you are using AQuA in stateful mode. Otherwise, if you are using AQuA in stateless mode, projectId can be null.

#[payload]

 

entityId

String

optional parameter if the Zuora customer has multiple entities (either entityId or entityName must be specified)

 

entityName

String

optional parameter if Zuora customer has multiple entities (either entityId or entityName must be specified)

 

Returns

Return Java Type Description

Job

Job object response.

Aqua delete job

<zuora:aqua-delete-job>

Deletes the current job, only if the job is not complete. If the job is complete, an error is thrown. see aquaDeleteJob()

XML Sample

<zuora:aqua-delete-job config-ref="Zuora__Configuration" jobId="id"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

jobId

String

the job ID

x 

entityId

String

optional parameter if the Zuora customer has multiple entities (either entityId or entityName must be specified)

 

entityName

String

optional parameter if Zuora customer has multiple entities (either entityId or entityName must be specified)

 

Returns

Return Java Type Description

Job

Job response that represents a job.

Aqua get job metadata

<zuora:aqua-get-job-metadata>

Converts an Object returned by the source into an instance of a Job

XML Sample

<zuora:aqua-get-job-metadata config-ref="Zuora__Configuration"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

jobResponse

Object

the jobResponse viewed as an Object

#[payload]

 

Returns

Return Java Type Description

Job

GetJobIdResponse the jobResponse as an instance of a GetJobIdResponse

Sources

Aqua get batch results

<zuora:aqua-get-batch-results>

Periodically polls for the status of the jobs retrieved from the object store and returns the results of the completed jobs

XML Sample

<zuora:aqua-get-batch-results config-ref="Zuora__Configuration" storeName="storeName" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

storeName

String

the name of the objectStore that holds the PostQuery results

 

callback

SourceCallback

The callback to call when a job is completed

x 

entityId

String

optional parameter if the Zuora customer has multiple entities (either entityId or entityName must be specified)

 

entityName

String

optional parameter if Zuora customer has multiple entities (either entityId or entityName must be specified)

 

Returns

Return Java Type Description

StopSourceCallback

Object representing the jobResponse