Contact Free trial Login

Zuora Connector Reference - Mule 4

Support Version: Select

Zuora Connector v4.2

Configurations


Config

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

The connection types to provide to this configuration.

x

host

String

Host for consuming API

rest.zuora.com

port

String

Port for consuming API

443

basePath

String

Basepath for consuming API.

x

protocol

String

Protocol for consuming API.

HTTPS

username

String

Username

x

password

String

Password

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime purges the instances when it sees fit.

Connection Types

Connection
  • None.

Supported Operations

Operations

Accept Connection Multi Entity

<mule-zuora-connector:accept-connection-multi-entity>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Connection Id

String

The ID of the connection that you want to accept.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Accept User Access Multi Entity

<mule-zuora-connector:accept-user-access-multi-entity>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Username

String

Specify the login name of the user that you want to accept the access request for.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Activate Accounting Code

<mule-zuora-connector:activate-accounting-code>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Ac Id

String

ID of the accounting code you want to update.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Add Attachments

<mule-zuora-connector:add-attachments>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Add Attachments Request Data

Any

#[payload]

Associated Object Type

String

Specify one of the following values: Account, Subscription, or Invoice.

x

Associated Object Key

String

For the Subscription type, specify the Subscription Number. An attachment is tied to the Subscription Number and thus viewable with every subscription version. For Account and Invoice, specify the id.

x

Description

String

Description of the attachment document.

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Amend

<mule-zuora-connector:amend>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Amend Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

X Zuora Wsdl Version

String

Zuora WSDL version number.

'79'

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Apply Credit Memo

<mule-zuora-connector:apply-credit-memo>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Apply Credit Memo Request Data

Any

#[payload]

Credit Memo Id

String

The unique ID of a credit memo.

For example: 8a8082e65b27f6c3015ba45ff82c7172

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Apply Payment

<mule-zuora-connector:apply-payment>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Apply Payment Request Data

Any

#[payload]

Payment Id

String

The unique ID of an unapplied payment.

For example: 8a8082e65b27f6c3015b89e4344c16b1

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Aqua_ Delete A Running Job

<mule-zuora-connector:aqua_—​delete-a-running-job>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

String

The ID of the job.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Aqua_ Get Job Results

<mule-zuora-connector:aqua_—​get-job-results>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

String

The ID of the job.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Aqua_ Get Last Job Completed

<mule-zuora-connector:aqua_—​get-last-job-completed>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Partner

String

The partner field indicates the unique ID of a data integration partner.

x

Project

String

The project field contains the unique ID of a data integration project for a particular partner.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Aqua_ Post Query Or Export Deleted Data

<mule-zuora-connector:aqua_—​post-query-or-export-deleted-data>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Aqua_ Post Query Or Export Deleted Data Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Cancel Authorization

<mule-zuora-connector:cancel-authorization>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Cancel Authorization Request Data

Any

#[payload]

Payment Method Id

String

Unique identifier of a payment method. (Since this ID is unique, and linked to a customer account in the system, no customer identifier is needed.)

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Cancel Credit Memo

<mule-zuora-connector:cancel-credit-memo>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Credit Memo Id

String

The unique ID of a credit memo.

For example: 8a8082e65b27f6c3015ba45ff82c7172

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Cancel Data Query Job

<mule-zuora-connector:cancel-data-query-job>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Job Id

String

Internal identifier of the query job.

x

Authorization

String

Bearer {token} for a valid OAuth token.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Cancel Debit Memo

<mule-zuora-connector:cancel-debit-memo>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Debit Memo Id

String

The unique ID of a debit memo.

For example: 8a8082e65b27f6c3015ba419f3c2644e

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Cancel Journal Run

<mule-zuora-connector:cancel-journal-run>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Jr Number

String

Journal run number. Must be a valid journal run number in the format JR-00000001

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Cancel Payment

<mule-zuora-connector:cancel-payment>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Payment Id

String

The unique ID of an unapplied payment.

For example: 8a8082e65b27f6c3015b89e4344c16b1

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Cancel Refund

<mule-zuora-connector:cancel-refund>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Refund Id

String

The unique ID of a refund.

For example: 4028905f5a87c0ff015a889e590e00c9

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Cancel Stored Credential Profile

<mule-zuora-connector:cancel-stored-credential-profile>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Payment Method Id

String

Unique identifier of a payment method. (Since this ID is unique, and linked to a customer account in the system, no customer identifier is needed.)

x

Profile Number

Number

Number that identifies a stored credential profile within the payment method.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Cancel Subscription

<mule-zuora-connector:cancel-subscription>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Cancel Subscription Request Data

Any

#[payload]

Subscription Key

String

Possible values are:

  • A subscription number

  • A subscription ID

x

Zuora Version

String

The minor version of the Zuora REST API.

You only need to set this parameter if you use these fields:

  • collect

  • invoice

  • runBilling

  • targetDate

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Cancel Summary Journal Entry

<mule-zuora-connector:cancel-summary-journal-entry>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Je Number

String

Journal entry number in the format JE-00000001.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Close Accounting Period

<mule-zuora-connector:close-accounting-period>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Ap Id

String

ID of the accounting period you want to delete.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create

<mule-zuora-connector:create>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

X Zuora Wsdl Version

String

Zuora WSDL version number.

'79'

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Array of Any

For Configurations

Create A Notification Definition

<mule-zuora-connector:create-a-notification-definition>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create A Notification Definition Request Data

Any

#[payload]

Authorization

String

Bearer {token} for a valid OAuth token. Note that you must regenerate the OAuth token after the Notification and the Configurable Event features are enabled in your Zuora tenant. The OAuth tokens generated before the features are turned on do not work.

x

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Account

<mule-zuora-connector:create-account>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Account Request Data

Any

#[payload]

Zuora Version

String

The minor version of the Zuora REST API.

You only need to set this parameter if you use these fields:

  • collect

  • invoice

  • runBilling

  • targetDate

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Account Crud

<mule-zuora-connector:create-account-crud>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Account Crud Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Accounting Code

<mule-zuora-connector:create-accounting-code>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Accounting Code Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Accounting Period

<mule-zuora-connector:create-accounting-period>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Accounting Period Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create An Email Template

<mule-zuora-connector:create-an-email-template>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create An Email Template Request Data

Any

#[payload]

Authorization

String

Bearer {token} for a valid OAuth token. Note that you must regenerate the OAuth token after the Notification and the Configurable Event features are enabled in your Zuora tenant. The OAuth tokens generated before the features are turned on do not work.

x

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create An Event Trigger

<mule-zuora-connector:create-an-event-trigger>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create An Event Trigger Request Data

Any

#[payload]

Authorization

String

Bearer {token} for a valid OAuth token.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Apple Pay Payment Method

<mule-zuora-connector:create-apple-pay-payment-method>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Apple Pay Payment Method Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Authorization

<mule-zuora-connector:create-authorization>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Authorization Request Data

Any

#[payload]

Payment Method Id

String

Unique identifier of a payment method. (Since this ID is unique, and linked to a customer account in the system, no customer identifier is needed.)

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Bill Run Crud

<mule-zuora-connector:create-bill-run-crud>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Bill Run Crud Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Billing Preview

<mule-zuora-connector:create-billing-preview>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Billing Preview Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Billing Preview Run

<mule-zuora-connector:create-billing-preview-run>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Billing Preview Run Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Contact Crud

<mule-zuora-connector:create-contact-crud>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Contact Crud Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Credit Balance Adjustment Crud

<mule-zuora-connector:create-credit-balance-adjustment-crud>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Credit Balance Adjustment Crud Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Credit Card Payment Method

<mule-zuora-connector:create-credit-card-payment-method>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Credit Card Payment Method Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Credit Memo From Charge

<mule-zuora-connector:create-credit-memo-from-charge>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Credit Memo From Charge Request Data

Any

#[payload]

Zuora Version

String

The minor version of the Zuora REST API. See Minor Version for information about REST API version control.

This header affects the availability of these fields:

  • amount

  • memoItemAmount

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Credit Memo From Invoice

<mule-zuora-connector:create-credit-memo-from-invoice>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Credit Memo From Invoice Request Data

Any

#[payload]

Invoice Id

String

The ID of the invoice.

For example: 2c92c8955bd63cc1015bd7c151af02ab

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Credit Memo Pdf

<mule-zuora-connector:create-credit-memo-pdf>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Credit Memo Id

String

The unique ID of a credit memo.

For example: 8a8082e65b27f6c3015ba45ff82c7172

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Debit Memo From Charge

<mule-zuora-connector:create-debit-memo-from-charge>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Debit Memo From Charge Request Data

Any

#[payload]

Zuora Version

String

The minor version of the Zuora REST API. See Minor Version for information about REST API version control.

This header affects the availability of the following fields:

  • amount

  • memoItemAmount

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Debit Memo From Invoice

<mule-zuora-connector:create-debit-memo-from-invoice>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Debit Memo From Invoice Request Data

Any

#[payload]

Invoice Id

String

The ID of the invoice.

For example: 2c92c8955bd63cc1015bd7c151af02ab

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Debit Memo Pdf

<mule-zuora-connector:create-debit-memo-pdf>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Debit Memo Id

String

The unique ID of a debit memo.

For example: 8a8082e65b27f6c3015ba419f3c2644e

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Document Properties

<mule-zuora-connector:create-document-properties>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Document Properties Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Entity Multi Entity

<mule-zuora-connector:create-entity-multi-entity>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Entity Multi Entity Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Export Crud

<mule-zuora-connector:create-export-crud>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Export Crud Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Import Crud

<mule-zuora-connector:create-import-crud>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Import Crud Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Invoice Adjustment Crud

<mule-zuora-connector:create-invoice-adjustment-crud>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Invoice Adjustment Crud Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Invoice Payment Crud

<mule-zuora-connector:create-invoice-payment-crud>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Invoice Payment Crud Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Job To Hard Delete Billing Document Files

<mule-zuora-connector:create-job-to-hard-delete-billing-document-files>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Job To Hard Delete Billing Document Files Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Journal Run

<mule-zuora-connector:create-journal-run>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Journal Run Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Order

<mule-zuora-connector:create-order>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Order Request Data

Any

#[payload]

Zuora Version

String

The minor version of the Zuora REST API.

You need to set this parameter if you use these fields:

  • subscriptions

  • subscriptionNumbers

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Order Asynchronously

<mule-zuora-connector:create-order-asynchronously>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Order Asynchronously Request Data

Any

#[payload]

Zuora Version

String

The minor version of the Zuora REST API.

You need to set this parameter if you use these fields:

  • subscriptions

  • subscriptionNumbers

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Payment

<mule-zuora-connector:create-payment>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Payment Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Payment Crud

<mule-zuora-connector:create-payment-crud>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Payment Crud Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Payment Method

<mule-zuora-connector:create-payment-method>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Payment Method Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Payment Method Crud

<mule-zuora-connector:create-payment-method-crud>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Payment Method Crud Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Payment Run

<mule-zuora-connector:create-payment-run>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Payment Run Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Product Crud

<mule-zuora-connector:create-product-crud>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Product Crud Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Product Rate Plan Charge Crud

<mule-zuora-connector:create-product-rate-plan-charge-crud>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Product Rate Plan Charge Crud Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Product Rate Plan Crud

<mule-zuora-connector:create-product-rate-plan-crud>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Product Rate Plan Crud Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Refund Crud

<mule-zuora-connector:create-refund-crud>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Refund Crud Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Revenue Schedule For Credit Memo Item Distribute By Date Range

<mule-zuora-connector:create-revenue-schedule-for-credit-memo-item-distribute-by-date-range>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Revenue Schedule For Credit Memo Item Distribute By Date Range Request Data

Any

#[payload]

Cmi Id

String

The unique ID of a credit memo item. You can get the credit memo item ID from the response of Get credit memo items.

x

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Revenue Schedule For Credit Memo Item Manual Distribution

<mule-zuora-connector:create-revenue-schedule-for-credit-memo-item-manual-distribution>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Revenue Schedule For Credit Memo Item Manual Distribution Request Data

Any

#[payload]

Cmi Id

String

The unique ID of a credit memo item. You can get the credit memo item ID from the response of Get credit memo items.

x

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Revenue Schedule For Debit Memo Item Distribute By Date Range

<mule-zuora-connector:create-revenue-schedule-for-debit-memo-item-distribute-by-date-range>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Revenue Schedule For Debit Memo Item Distribute By Date Range Request Data

Any

#[payload]

Dmi Id

String

The unique ID of a debit memo item. You can get the debit memo item ID from the response of Get debit memo items.

x

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Revenue Schedule For Debit Memo Item Manual Distribution

<mule-zuora-connector:create-revenue-schedule-for-debit-memo-item-manual-distribution>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Revenue Schedule For Debit Memo Item Manual Distribution Request Data

Any

#[payload]

Dmi Id

String

The unique ID of a debit memo item. You can get the debit memo item ID from the response of Get debit memo items.

x

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Revenue Schedule For Invoice Item Adjustment Distribute By Date Range

<mule-zuora-connector:create-revenue-schedule-for-invoice-item-adjustment-distribute-by-date-range>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Revenue Schedule For Invoice Item Adjustment Distribute By Date Range Request Data

Any

#[payload]

Invoice Item Adj Key

String

ID or number of the Invoice Item Adjustment, for example, e20b07fd416dcfcf0141c81164fd0a72. If the specified Invoice Item Adjustment is already associated with a revenue schedule, the call fails.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Revenue Schedule For Invoice Item Adjustment Manual Distribution

<mule-zuora-connector:create-revenue-schedule-for-invoice-item-adjustment-manual-distribution>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Revenue Schedule For Invoice Item Adjustment Manual Distribution Request Data

Any

#[payload]

Invoice Item Adj Key

String

ID or number of the Invoice Item Adjustment, for example, e20b07fd416dcfcf0141c81164fd0a72. If the specified Invoice Item Adjustment is already associated with a revenue schedule, the call fails.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Revenue Schedule For Invoice Item Distribute By Date Range

<mule-zuora-connector:create-revenue-schedule-for-invoice-item-distribute-by-date-range>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Revenue Schedule For Invoice Item Distribute By Date Range Request Data

Any

#[payload]

Invoice Item Id

String

A valid Invoice Item ID.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Revenue Schedule For Invoice Item Manual Distribution

<mule-zuora-connector:create-revenue-schedule-for-invoice-item-manual-distribution>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Revenue Schedule For Invoice Item Manual Distribution Request Data

Any

#[payload]

Invoice Item Id

String

A valid Invoice Item ID.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Revenue Schedule On Subscription Charge

<mule-zuora-connector:create-revenue-schedule-on-subscription-charge>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Revenue Schedule On Subscription Charge Request Data

Any

#[payload]

Charge Key

String

ID of the subscription rate plan charge; for example, 402892793e173340013e173b81000012.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Sequence Sets

<mule-zuora-connector:create-sequence-sets>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Sequence Sets Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Stored Credential Profile

<mule-zuora-connector:create-stored-credential-profile>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Stored Credential Profile Request Data

Any

#[payload]

Payment Method Id

String

Unique identifier of a payment method. (Since this ID is unique, and linked to a customer account in the system, no customer identifier is needed.)

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Subscription

<mule-zuora-connector:create-subscription>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Subscription Request Data

Any

#[payload]

Zuora Version

String

The minor version of the Zuora REST API.

You only need to set this parameter if you use these fields:

  • collect

  • invoice

  • runBilling

  • targetDate

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Summary Journal Entry

<mule-zuora-connector:create-summary-journal-entry>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Summary Journal Entry Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Taxation Item Crud

<mule-zuora-connector:create-taxation-item-crud>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Taxation Item Crud Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Taxation Items For Credit Memo

<mule-zuora-connector:create-taxation-items-for-credit-memo>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Taxation Items For Credit Memo Request Data

Any

#[payload]

Credit Memo Id

String

The unique ID of a credit memo.

For example: 8a8082e65b27f6c3015ba45ff82c7172

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Taxation Items For Debit Memo

<mule-zuora-connector:create-taxation-items-for-debit-memo>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Taxation Items For Debit Memo Request Data

Any

#[payload]

Debit Memo Id

String

The unique ID of a debit memo.

For example: 8a8082e65b27f6c3015ba419f3c2644e

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Unit Of Measure Crud

<mule-zuora-connector:create-unit-of-measure-crud>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Unit Of Measure Crud Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Create Usage Crud

<mule-zuora-connector:create-usage-crud>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Usage Crud Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Deactivate Accounting Code

<mule-zuora-connector:deactivate-accounting-code>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Ac Id

String

ID of the accounting code you want to update.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Decrypt Rsa Signature

<mule-zuora-connector:decrypt-rsa-signature>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Decrypt Rsa Signature Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Delete

<mule-zuora-connector:delete>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Delete Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

X Zuora Wsdl Version

String

Zuora WSDL version number.

'79'

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Array of Any

For Configurations

Delete A Notification Definition

<mule-zuora-connector:delete-a-notification-definition>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

String

The ID of the notification definition to be deleted.

x

Authorization

String

Bearer {token} for a valid OAuth token. Note that you must regenerate the OAuth token after the Notification and the Configurable Event features are enabled in your Zuora tenant. The OAuth tokens generated before the features are turned on do not work.

x

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

For Configurations

Delete Account Crud

<mule-zuora-connector:delete-account-crud>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

String

Object id

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Delete Accounting Code

<mule-zuora-connector:delete-accounting-code>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Ac Id

String

ID of the accounting code you want to update.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Delete Accounting Period

<mule-zuora-connector:delete-accounting-period>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Ap Id

String

ID of the accounting period you want to delete.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Delete Amendment Crud

<mule-zuora-connector:delete-amendment-crud>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

String

Object id

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Delete An Email Template

<mule-zuora-connector:delete-an-email-template>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

String

The ID of the email template to be deleted.

x

Authorization

String

Bearer {token} for a valid OAuth token. Note that you must regenerate the OAuth token after the Notification and the Configurable Event features are enabled in your Zuora tenant. The OAuth tokens generated before the features are turned on do not work.

x

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

For Configurations

Delete Attachments

<mule-zuora-connector:delete-attachments>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Attachment Id

String

Id of the attachment to be deleted.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Delete Bill Run Crud

<mule-zuora-connector:delete-bill-run-crud>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

String

Object id

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Delete Contact Crud

<mule-zuora-connector:delete-contact-crud>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

String

Object id

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Delete Credit Memo

<mule-zuora-connector:delete-credit-memo>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Credit Memo Id

String

The unique ID of a credit memo.

For example: 8a8082e65b27f6c3015ba45ff82c7172

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Delete Debit Memo

<mule-zuora-connector:delete-debit-memo>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Debit Memo Id

String

The unique ID of a debit memo.

For example: 8a8082e65b27f6c3015ba419f3c2644e

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Delete Document Properties

<mule-zuora-connector:delete-document-properties>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Document Properties Id

String

The unique ID of document properties.

For example: 402892c74c9193cd014c96bbe7c101f9

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Delete Entity Multi Entity

<mule-zuora-connector:delete-entity-multi-entity>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

String

Specify the Id of the entity that you want to delete. You can get the entity Id from the GET Entities call.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Delete Feature Crud

<mule-zuora-connector:delete-feature-crud>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

String

Object id

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Delete Invoice Adjustment Crud

<mule-zuora-connector:delete-invoice-adjustment-crud>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

String

Object id

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Delete Invoice Crud

<mule-zuora-connector:delete-invoice-crud>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

String

Object id

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Delete Invoice Item Adjustment Crud

<mule-zuora-connector:delete-invoice-item-adjustment-crud>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

String

Object id

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Delete Journal Run

<mule-zuora-connector:delete-journal-run>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Jr Number

String

Journal run number. Must be a valid journal run number in the format JR-00000001

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Delete Order

<mule-zuora-connector:delete-order>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Order Number

String

The number of the order to be deleted.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Delete Payment

<mule-zuora-connector:delete-payment>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Payment Id

String

The unique ID of an unapplied payment.

For example: 8a8082e65b27f6c3015b89e4344c16b1

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Delete Payment Crud

<mule-zuora-connector:delete-payment-crud>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

String

The unique ID of the payment to be deleted.

For example: 2c92c0f85d4e95ae015d4f7e5d690622

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Delete Payment Method

<mule-zuora-connector:delete-payment-method>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Payment Method Id

String

Unique identifier of a payment method. (Since this ID is unique, and linked to a customer account in the system, no customer identifier is needed.)

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Delete Payment Method Crud

<mule-zuora-connector:delete-payment-method-crud>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

String

Object id

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Delete Payment Method Snapshot Crud

<mule-zuora-connector:delete-payment-method-snapshot-crud>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

String

Object id

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Delete Payment Run

<mule-zuora-connector:delete-payment-run>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Payment Run Id

String

The unique ID of a payment run.

For example: 402890245f097f39015f0f074a2e0566

x

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Delete Product Crud

<mule-zuora-connector:delete-product-crud>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

String

Object id

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Delete Product Feature Crud

<mule-zuora-connector:delete-product-feature-crud>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

String

Object id

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Delete Product Rate Plan Charge Crud

<mule-zuora-connector:delete-product-rate-plan-charge-crud>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

String

The unique ID of the product rate plan charge to be deleted.

For example: 2c93808457d787030157e031fcd34e19

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Delete Product Rate Plan Crud

<mule-zuora-connector:delete-product-rate-plan-crud>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

String

Object id

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Delete Refund

<mule-zuora-connector:delete-refund>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Refund Id

String

The unique ID of a refund.

For example: 4028905f5a87c0ff015a889e590e00c9

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Delete Refund Crud

<mule-zuora-connector:delete-refund-crud>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

String

Object id

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Delete Revenue Schedule

<mule-zuora-connector:delete-revenue-schedule>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Rs Number

String

Revenue schedule number of the revenue schedule you want to delete, for example, RS-00000256.

To be deleted, the revenue schedule:

  • Must be using a custom unlimited recognition rule.

  • Cannot have any revenue in a closed accounting period.

  • Cannot be included in a summary journal entry

  • Cannot have a revenue schedule date in a closed accounting period.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Delete Sequence Set

<mule-zuora-connector:delete-sequence-set>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

String

The ID of the sequence set to delete

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Delete Subscription Crud

<mule-zuora-connector:delete-subscription-crud>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

String

Object id

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Delete Summary Journal Entry

<mule-zuora-connector:delete-summary-journal-entry>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Je Number

String

Journal entry number in the format JE-00000001.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Delete Taxation Item

<mule-zuora-connector:delete-taxation-item>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

String

The unique ID of a taxation item.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Delete Taxation Item Crud

<mule-zuora-connector:delete-taxation-item-crud>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

String

Object id

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Delete Unit Of Measure Crud

<mule-zuora-connector:delete-unit-of-measure-crud>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

String

Object id

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Delete Usage Crud

<mule-zuora-connector:delete-usage-crud>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

String

Object id

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Deny Connection Multi Entity

<mule-zuora-connector:deny-connection-multi-entity>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Connection Id

String

The ID of the connection that you want to accept.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Deny User Access Multi Entity

<mule-zuora-connector:deny-user-access-multi-entity>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Username

String

Specify the login name of the user that you want to accept the access request for.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Describe Object

<mule-zuora-connector:describe-object>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Object

String

API name of an object in your Zuora tenant.

For example: InvoiceItem. See Zuora Object Model for the list of valid object names. Depending on the features enabled in your Zuora tenant, you may not be able to list the fields of some objects.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

String

For Configurations

Disconnect Connection Multi Entity

<mule-zuora-connector:disconnect-connection-multi-entity>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Connection Id

String

The ID of the connection that you want to accept.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Distribute Revenue Across Accounting Periods

<mule-zuora-connector:distribute-revenue-across-accounting-periods>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Distribute Revenue Across Accounting Periods Request Data

Any

#[payload]

Rs Number

String

Revenue schedule number of the revenue schedule you want to delete, for example, RS-00000256.

To be deleted, the revenue schedule:

  • Must be using a custom unlimited recognition rule.

  • Cannot have any revenue in a closed accounting period.

  • Cannot be included in a summary journal entry.

  • Cannot have a revenue schedule date in a closed accounting period.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Distribute Revenue By Recognition Start And End Dates

<mule-zuora-connector:distribute-revenue-by-recognition-start-and-end-dates>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Distribute Revenue By Recognition Start And End Dates Request Data

Any

#[payload]

Rs Number

String

Revenue schedule number of the revenue schedule you want to delete, for example, RS-00000256.

To be deleted, the revenue schedule:

  • Must be using a custom unlimited recognition rule.

  • Cannot have any revenue in a closed accounting period.

  • Cannot be included in a summary journal entry.

  • Cannot have a revenue schedule date in a closed accounting period.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Distribute Revenue On Specific Date

<mule-zuora-connector:distribute-revenue-on-specific-date>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Distribute Revenue On Specific Date Request Data

Any

#[payload]

Rs Number

String

Revenue schedule number of the revenue schedule you want to delete, for example, RS-00000256.

To be deleted, the revenue schedule:

  • Must be using a custom unlimited recognition rule.

  • Cannot have any revenue in a closed accounting period.

  • Cannot be included in a summary journal entry.

  • Cannot have a revenue schedule date in a closed accounting period.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Edit Attachments

<mule-zuora-connector:edit-attachments>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Edit Attachments Request Data

Any

#[payload]

Attachment Id

String

Id of the attachment to be deleted.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Email Billing Documents Generated From Bill Run

<mule-zuora-connector:email-billing-documents-generated-from-bill-run>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Email Billing Documents Generated From Bill Run Request Data

Any

#[payload]

Bill Run Id

String

The ID of the bill run.

For example: 2c92c8f95d0c886e015d11287a8f0f8b

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Email Credit Memo

<mule-zuora-connector:email-credit-memo>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Email Credit Memo Request Data

Any

#[payload]

Credit Memo Id

String

The unique ID of a credit memo.

For example: 8a8082e65b27f6c3015ba45ff82c7172

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Email Debit Memo

<mule-zuora-connector:email-debit-memo>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Email Debit Memo Request Data

Any

#[payload]

Debit Memo Id

String

The unique ID of a debit memo.

For example: 8a8082e65b27f6c3015ba419f3c2644e

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Email Invoice

<mule-zuora-connector:email-invoice>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Email Invoice Request Data

Any

#[payload]

Invoice Id

String

The ID of the invoice.

For example: 2c92c8955bd63cc1015bd7c151af02ab

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Establish Connection To Zuora Rest Api Service

<mule-zuora-connector:establish-connection-to-zuora-rest-api-service>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Api Access Key Id

String

Account username

x

Api Secret Access Key

String

Account password

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Execute

<mule-zuora-connector:execute>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Execute Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

X Zuora Wsdl Version

String

Zuora WSDL version number.

'79'

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Array of Any

For Configurations

Expire Stored Credential Profile

<mule-zuora-connector:expire-stored-credential-profile>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Payment Method Id

String

Unique identifier of a payment method. (Since this ID is unique, and linked to a customer account in the system, no customer identifier is needed.)

x

Profile Number

Number

Number that identifies a stored credential profile within the payment method.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Generate

<mule-zuora-connector:generate>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Generate Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

X Zuora Wsdl Version

String

Zuora WSDL version number.

'79'

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Array of Any

For Configurations

Generate An Oauth Token

<mule-zuora-connector:generate-an-oauth-token>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Generate An Oauth Token Request Data

Any

#[payload]

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Generate Billing Documents By Account

<mule-zuora-connector:generate-billing-documents-by-account>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Generate Billing Documents By Account Request Data

Any

#[payload]

Id

String

The ID of the customer account that billing documents are generated for.

For example: 8a8082e65b27f6c3015ba3e326b26419

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Generate Quotes Document

<mule-zuora-connector:generate-quotes-document>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Generate Quotes Document Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Generate Rsa Signature

<mule-zuora-connector:generate-rsa-signature>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Generate Rsa Signature Request Data

Any

#[payload]

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get A Notification Definition

<mule-zuora-connector:get-a-notification-definition>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

String

The ID of the notification definition to be deleted.

x

Authorization

String

Bearer {token} for a valid OAuth token. Note that you must regenerate the OAuth token after the Notification and the Configurable Event features are enabled in your Zuora tenant. The OAuth tokens generated before the features are turned on do not work.

x

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get Account

<mule-zuora-connector:get-account>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Account Key

String

Account number or account ID.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get Account Crud

<mule-zuora-connector:get-account-crud>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Fields

String

Object fields to return

Id

String

Object id

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get Account Summary

<mule-zuora-connector:get-account-summary>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Account Key

String

Account number or account ID.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get Accounting Code

<mule-zuora-connector:get-accounting-code>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Ac Id

String

ID of the accounting code you want to update.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get Accounting Period

<mule-zuora-connector:get-accounting-period>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Ap Id

String

ID of the accounting period you want to delete.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get All Accounting Codes

<mule-zuora-connector:get-all-accounting-codes>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Page Size

Number

Number of rows returned per page.

300

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get All Accounting Periods

<mule-zuora-connector:get-all-accounting-periods>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Page Size

Number

Number of rows returned per page.

300

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get All Orders

<mule-zuora-connector:get-all-orders>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Page

Number

The page number of the orders retrieved.

1

Date Filter Option

String

The date type to filter on. This field value can be orderDate or updatedDate. Default is orderDate.

Start Date

Date

The result only contains the orders with the date of dateFilterOption later than or equal to this date.

End Date

Date

The result only contains orders with the date of dateFilterOption earlier than or equal to this date.

Page Size

Number

Number of rows returned per page.

20

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get All Payments

<mule-zuora-connector:get-all-payments>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Account Id

String

This parameter filters the response based on the accountId field.

Amount

Number

This parameter filters the response based on the amount field.

Applied Amount

Number

This parameter filters the response based on the appliedAmount field.

Created By Id

String

This parameter filters the response based on the createdById field.

Created Date

Date

This parameter filters the response based on the createdDate field.

Credit Balance Amount

Number

This parameter filters the response based on the creditBalanceAmount field.

Currency

String

This parameter filters the response based on the currency field.

Effective Date

Date

This parameter filters the response based on the effectiveDate field.

Number

String

This parameter filters the response based on the number field.

Refund Amount

Number

This parameter filters the response based on the refundAmount field.

Status

String

This parameter filters the response based on the status field.

Type

String

This parameter filters the response based on the type field.

Unapplied Amount

Number

This parameter filters the response based on the unappliedAmount field.

Updated By Id

String

This parameter filters the response based on the updatedById field.

Updated Date

Date

This parameter filters the response based on the updatedDate field.

Sort

String

This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on.

A sortable field uses the following form:

operator field_name

You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields.

For example: operator field_name, operator field_name

operator is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field.

  • The - operator indicates an ascending order.

  • The + operator indicates a descending order. By default, the response data displays in descending order by payment number. field_name indicates the name of a sortable field.

The supported sortable fields for this operation are:

  • accountId

  • amount

  • appliedAmount

  • createdById

  • createdDate

  • creditBalanceAmount

  • effectiveDate

  • number

  • refundAmount

  • unappliedAmount

  • updatedById

  • updatedDate

Examples:

  • /v1/payments?sort=+number

  • /v1/payments?status=Processed&sort=-number,+amount

Page Size

Number

Number of rows returned per page.

20

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get All Refunds

<mule-zuora-connector:get-all-refunds>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Account Id

String

This parameter filters the response based on the accountId field.

Amount

Number

This parameter filters the response based on the amount field.

Created By Id

String

This parameter filters the response based on the createdById field.

Created Date

Date

This parameter filters the response based on the createdDate field.

Method Type

String

This parameter filters the response based on the methodType field.

Number

String

This parameter filters the response based on the number field.

Payment Id

String

This parameter filters the response based on the paymentId field.

Refund Date

Date

This parameter filters the response based on the refundDate field.

Status

String

This parameter filters the response based on the status field.

Type

String

This parameter filters the response based on the type field.

Updated By Id

String

This parameter filters the response based on the updatedById field.

Updated Date

Date

This parameter filters the response based on the updatedDate field.

Sort

String

This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on.

A sortable field uses the following form:

operator field_name

You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields.

For example: operator field_name, operator field_name

operator marks the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field.

  • The - operator indicates an ascending order.

  • The + operator indicates a descending order. By default, the response data is displayed in descending order by refund number. field_name indicates the name of a sortable field.

The supported sortable fields of this operation are:

  • accountId

  • amount

  • createdById

  • createdDate

  • number

  • paymentId

  • refundDate

  • updatedById

  • updatedDate

Examples:

  • /v1/refunds?sort=+number

  • /v1/refunds?status=Processed&sort=-number,+amount

Page Size

Number

Number of rows returned per page.

20

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get All Revenue Schedules Of Product Charge By Charge Id And Billing Account Id

<mule-zuora-connector:get-all-revenue-schedules-of-product-charge-by-charge-id-and-billing-account-id>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Page Size

Number

Number of rows returned per page.

8

Charge Key

String

The unique ID of a product rate plan charge.

For example: 8a8082e65ba86084015bb323d3c61d82

x

Account Key

String

The account number or account ID.

x

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get All Summary Journal Entries In A Journal Run

<mule-zuora-connector:get-all-summary-journal-entries-in-a-journal-run>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Page Size

Number

Number of rows returned per page.

8

Jr Number

String

Journal run number.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get Amendment Get Amendment

<mule-zuora-connector:get-amendment-get-amendment>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Fields

String

Object fields to return

Id

String

Object id

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get Amendments By Key

<mule-zuora-connector:get-amendments-by-key>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Amendment Key

String

Can be the amendment ID or the amendment code.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get Amendments By Subscription Id

<mule-zuora-connector:get-amendments-by-subscription-id>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Subscription Id

String

The ID of the subscription whose amendment changes you want to retrieve.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get An Email Template

<mule-zuora-connector:get-an-email-template>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

String

The ID of the email template to be deleted.

x

Authorization

String

Bearer {token} for a valid OAuth token. Note that you must regenerate the OAuth token after the Notification and the Configurable Event features are enabled in your Zuora tenant. The OAuth tokens generated before the features are turned on do not work.

x

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get An Event Trigger By Id

<mule-zuora-connector:get-an-event-trigger-by-id>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Id

String

x

Authorization

String

Bearer {token} for a valid OAuth token.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get An Order

<mule-zuora-connector:get-an-order>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Order Number

String

The number of the order to be deleted.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get Billing Documents

<mule-zuora-connector:get-billing-documents>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Account Id

String

The ID of the customer account that the billing documents are associated with.

x

Document Date

Date

The date of the billing document. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos.

Status

String

The status of the billing document.

Sort

String

This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on.

A sortable field uses the form: operator field_name

You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields.

For example: operator field_name, operator field_name

operator marks the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field.

  • The - operator indicates an ascending order.

  • The + operator indicates a descending order. By default, the response data is displayed in descending order by refund number. field_name indicates the name of a sortable field.

The supported sortable fields of this operation are:

  • documentDate

  • documentType

Examples:

  • /billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1&sort=+documentDate,-documentType

  • /billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1&status=Posted&sort=+documentDate&page=2&pageSize=15

Page Size

Number

Number of rows returned per page.

20

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get Billing Information For Order

<mule-zuora-connector:get-billing-information-for-order>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

As Of Date

Date

Billing states of the order are calculated as of this date. Invoices with the invoice date later than this date are not counted into the billed amount. The default value is today.

Order Number

String

The number of the order to be deleted.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get Billing Preview Run

<mule-zuora-connector:get-billing-preview-run>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Billing Preview Run Id

String

Id of the billing preview run.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get Breakdown Of Credit Memo By Order

<mule-zuora-connector:get-breakdown-of-credit-memo-by-order>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Credit Memo Number

String

Number of credit memo to be broken down.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get Breakdown Of Invoice By Order

<mule-zuora-connector:get-breakdown-of-invoice-by-order>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Invoice Number

String

Number of invoice to be broken down.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get Callout Notification Histories

<mule-zuora-connector:get-callout-notification-histories>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

End Time

Date

The final date and time of records to be returned. Defaults to now. Use the format yyyy-MM-ddTHH:mm:ss

Start Time

Date

The initial date and time of records to be returned. Defaults to (end time - 1 day). Use the format yyyy-MM-ddTHH:mm:ss

Object Id

String

The ID of an object that triggered a callout notification.

Failed Only

Boolean

If true, only return failed records. If false, return all records in the given date range. The default value is true

Event Category

String

Category of records to be returned by event category.

The following formats are supported:

  • Event Type Namespace:Event Type Name - If the Configurable Event features are enabled in your Zuora tenant. For example: user.notification:NewSubscriptionCreated

  • Otherwise, the numeric code of the event category. For example: 1210 See Event Categories for Notifications for more information.

Include Response Content

Boolean

Page Size

Number

Number of rows returned per page.

20

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get Charge Summary Details By Charge Id

<mule-zuora-connector:get-charge-summary-details-by-charge-id>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Charge Key

String

ID of the subscription rate plan charge; for example, 402892793e173340013e173b81000012.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get Charge Summary Details By Crs Number

<mule-zuora-connector:get-charge-summary-details-by-crs-number>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Crs Number

String

The charge revenue summary number.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get Connections Multi Entity

<mule-zuora-connector:get-connections-multi-entity>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Type

String

Specifies whether to retrieve inbound or outbound connections for an entity. Possible values: - inbound: All the incoming connections to the entity. - outbound: All the outgoing connections from the entity. If you do not specify this field in the request, both the inbound and outbound connections are returned.

Page Size

Number

Number of rows returned per page.

30

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get Credit Card Payment Methods For Account

<mule-zuora-connector:get-credit-card-payment-methods-for-account>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Page Size

Number

Number of rows returned per page.

20

Account Key

String

Account number or account ID.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get Credit Memo

<mule-zuora-connector:get-credit-memo>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Credit Memo Id

String

The unique ID of a credit memo.

For example: 8a8082e65b27f6c3015ba45ff82c7172

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get Credit Memo Item

<mule-zuora-connector:get-credit-memo-item>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Credit Memo Id

String

The unique ID of a credit memo.

For example: 8a8082e65b27f6c3015ba45ff82c7172

x

Cmitemid

String

The unique ID of a credit memo item. You can get the credit memo item ID from the response of Get credit memo items.

x

Zuora Version

String

The minor version of the Zuora REST API. See Minor Version for information about REST API version control.

This header affects the availability of the following fields:

  • creditTaxItems

  • taxationItems

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get Credit Memo Items

<mule-zuora-connector:get-credit-memo-items>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Amount

Number

This parameter filters the response based on the amount field.

Applied Amount

Number

This parameter filters the response based on the appliedAmount field.

Created By Id

String

This parameter filters the response based on the createdById field.

Created Date

Date

This parameter filters the response based on the createdDate field.

Id

String

This parameter filters the response based on the id field.

Refund Amount

Number

This parameter filters the response based on the refundAmount field.

Service End Date

Date

This parameter filters the response based on the serviceEndDate field.

Service Start Date

Date

This parameter filters the response based on the serviceStartDate field.

Sku

String

This parameter filters the response based on the sku field.

Sku Name

String

This parameter filters the response based on the skuName field.

Source Item Id

String

This parameter filters the response based on the sourceItemId field.

Subscription Id

String

This parameter filters the response based on the subscriptionId field.

Updated By Id

String

This parameter filters the response based on the updatedById field.

Updated Date

Date

This parameter filters the response based on the updatedDate field.

Sort

String

This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on.

A sortable field uses the following form: operator field_name

You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields.

For example: operator field_name, operator field_name

operator is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without an operator, the response data is sorted in descending order by this field.

  • The - operator indicates an ascending order.

  • The + operator indicates a descending order. By default, the response data is displayed in descending order by updated date. field_name indicates the name of a sortable field.

The supported sortable fields for this operation are:

  • amount

  • appliedAmount

  • createdById

  • createdDate

  • id

  • refundAmount

  • serviceEndDate

  • serviceStartDate

  • sku

  • skuName

  • sourceItemId

  • subscriptionId

  • updatedById

  • updatedDate

Examples:

  • /v1/creditmemos/402890245c7ca371015c7cb40ac30015/items?sort=createdDate

  • /v1/creditmemos/402890245c7ca371015c7cb40ac30015/items?amount=100&sort=createdDate

Page Size

Number

Number of rows returned per page.

20

Credit Memo Id

String

The unique ID of a credit memo.

For example: 8a8082e65b27f6c3015ba45ff82c7172

x

Zuora Version

String

The minor version of the Zuora REST API. See Minor Version for information about REST API version control.

This header affects the availability of:

  • creditTaxItems

  • taxationItems

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get Credit Memo Part

<mule-zuora-connector:get-credit-memo-part>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Credit Memo Id

String

The unique ID of a credit memo.

For example: 8a8082e65b27f6c3015ba45ff82c7172

x

Partid

String

The unique ID of a specific credit memo part. You can get the credit memo part ID from the response of Get credit memo parts.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get Credit Memo Part Item

<mule-zuora-connector:get-credit-memo-part-item>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Credit Memo Id

String

The unique ID of a credit memo.

For example: 8a8082e65b27f6c3015ba45ff82c7172

x

Partid

String

The unique ID of a specific credit memo part. You can get the credit memo part ID from the response of Get credit memo parts.

x

Itempartid

String

The unique ID of a specific credit memo part item. You can get the credit memo part item ID from the response of Get credit memo part items.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get Credit Memo Part Items

<mule-zuora-connector:get-credit-memo-part-items>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Page Size

Number

Number of rows returned per page.

20

Credit Memo Id

String

The unique ID of a credit memo.

For example: 8a8082e65b27f6c3015ba45ff82c7172

x

Partid

String

The unique ID of a specific credit memo part. You can get the credit memo part ID from the response of Get credit memo parts.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get Credit Memo Parts

<mule-zuora-connector:get-credit-memo-parts>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Page Size

Number

Number of rows returned per page.

20

Credit Memo Id

String

The unique ID of a credit memo.

For example: 8a8082e65b27f6c3015ba45ff82c7172

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get Credit Memos

<mule-zuora-connector:get-credit-memos>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Account Id

String

This parameter filters the response based on the accountId field.

Amount

Number

This parameter filters the response based on the amount field.

Applied Amount

Number

This parameter filters the response based on the appliedAmount field.

Auto Apply Upon Posting

Boolean

This parameter filters the response based on the autoApplyUponPosting field.

Created By Id

String

This parameter filters the response based on the createdById field.

Created Date

Date

This parameter filters the response based on the createdDate field.

Credit Memo Date

Date

This parameter filters the response based on the creditMemoDate field.

Currency

String

This parameter filters the response based on the currency field.

Exclude From Auto Apply Rules

Boolean

This parameter filters the response based on the excludeFromAutoApplyRules field.

Number

String

This parameter filters the response based on the number field.

Referred Invoice Id

String

This parameter filters the response based on the referredInvoiceId field.

Refund Amount

Number

This parameter filters the response based on the refundAmount field.

Status

String

This parameter filters the response based on the status field.

Target Date

Date

This parameter filters the response based on the targetDate field.

Tax Amount

Number

This parameter filters the response based on the taxAmount field.

Total Tax Exempt Amount

Number

This parameter filters the response based on the totalTaxExemptAmount field.

Transferred To Accounting

String

This parameter filters the response based on the transferredToAccounting field.

Unapplied Amount

Number

This parameter filters the response based on the unappliedAmount field.

Updated By Id

String

This parameter filters the response based on the updatedById field.

Updated Date

Date

This parameter filters the response based on the updatedDate field.

Sort

String

This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on.

A sortable field uses the following form: operator field_name

You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields.

For example: operator field_name, operator field_name

operator marks the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field.

  • The - operator indicates an ascending order.

  • The + operator indicates a descending order. By default, the response data is displayed in descending order by refund number. field_name indicates the name of a sortable field.

The supported sortable fields of this operation are:

  • accountId

  • amount

  • appliedAmount

  • createdById

  • createdDate

  • creditMemoDate

  • number

  • referredInvoiceId

  • refundAmount

  • status

  • targetDate

  • taxAmount

  • totalTaxExemptAmount

  • transferredToAccounting

  • unappliedAmount

  • updatedDate

Examples:

  • /v1/refunds?sort=+number

  • /v1/refunds?status=Processed&sort=-number,+amount

Page Size

Number

Number of rows returned per page.

20

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get Custom Foreign Currency Exchange Rates

<mule-zuora-connector:get-custom-foreign-currency-exchange-rates>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Start Date

String

Start date of the date range for which you want to get exchange rates. The date must be in yyyy-mm-dd format, for example, 2019-01-15. The start date cannot be later than the end date.

x

End Date

String

End date of the date range for which you want to get exchange rates. The date must be in yyyy-mm-dd format, for example, 2019-01-16. The end date can be a maximum of 90 days after the start date.

x

Currency

String

The target base currency of the tenant. The exchange rates in the response are calculated in relation to the target currency. The value must be a three-letter currency code, for example, USD.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get Data Query Job

<mule-zuora-connector:get-data-query-job>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Job Id

String

Internal identifier of the query job.

x

Authorization

String

Bearer {token} for a valid OAuth token.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get Data Query Jobs

<mule-zuora-connector:get-data-query-jobs>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Query Status

String

Filters the list of query jobs by status.

Page Size

Number

Specifies the maximum number of query jobs to return.

20

Authorization

String

Bearer {token} for a valid OAuth token.

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Zuora Track Id

String

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get Debit Memo

<mule-zuora-connector:get-debit-memo>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Debit Memo Id

String

The unique ID of a debit memo.

For example: 8a8082e65b27f6c3015ba419f3c2644e

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get Debit Memo Application Parts

<mule-zuora-connector:get-debit-memo-application-parts>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Debit Memo Id

String

The unique ID of a debit memo.

For example: 8a8082e65b27f6c3015ba419f3c2644e

x

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get Debit Memo Item

<mule-zuora-connector:get-debit-memo-item>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Debit Memo Id

String

The unique ID of a debit memo.

For example: 8a8082e65b27f6c3015ba419f3c2644e

x

Dmitemid

String

The unique ID of a debit memo item. You can get the debit memo item ID from the response of Get debit memo items.

x

Zuora Version

String

The minor version of the Zuora REST API. See Minor Version for information about REST API version control.

This header affects the availability of:

  • taxItems

  • taxationItems

Zuora Entity Ids

String

An entity ID. If you have Zuora Multi-Entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-Entity enabled, you do not need to set this header.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Output

Type

Any

For Configurations

Get Debit Memo Items

<mule-zuora-connector:get-debit-memo-items>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Amount

Number

This parameter filters the response based on the amount field.

Be Applied Amount

Number

This parameter filters the response based on the beAppliedAmount field.

Created By Id

String

This parameter filters the response based on the createdById field.

Created Date

Date

This parameter filters the response based on the createdDate field.

Id

String

This parameter filters the response based on the id field.

Service End Date

Date

This parameter filters the response based on the serviceEndDate field.

Service Start Date

Date

This parameter filters the response based on the serviceStartDate field.

Sku

String

This parameter filters the response based on the sku field.

Sku Name

String

This parameter filters the response based on the skuName field.

Source Item Id

String

This parameter filters the response based on the sourceItemId field.

Subscription Id

String