Nav

Zuora Connector Module Documentation Reference

Default Configuration

Parameters

Name Type Description Default Value Required

Name

String

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

x

Connection

config_connection, Connection

The connection types that can be provided 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

ExpirationPolicy

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 the platform expires an eligible instance. The runtime purges instances as it sees fit.

Supported Operations

  • Default Configuration

  • Accept Connection Multi Entity

  • Accept User Access Multi Entity

  • Activate Accounting Code

  • Add Attachments

  • Amend

  • Apply Credit Memo

  • Apply Payment

  • Cancel Credit Memo

  • Cancel Debit Memo

  • Cancel Journal Run

  • Cancel Payment

  • Cancel Refund

  • Cancel Subscription

  • Cancel Summary Journal Entry

  • Close Accounting Period

  • Create

  • Create Account

  • Create Account Crud

  • Create Accounting Code

  • Create Accounting Period

  • Create Amendment Crud

  • Create And Activate Order

  • Create Apple Pay Payment Method

  • Create Bill Run Crud

  • Create Billing Preview

  • Create Billing Preview Run

  • Create Contact Crud

  • Create Credit Memo From Charge

  • Create Credit Memo From Invoice

  • Create Credit Memo Pdf

  • Create Debit Memo From Charge

  • Create Debit Memo From Invoice

  • Create Debit Memo Pdf

  • Create Entity Multi Entity

  • Create Export Crud

  • Create Import Crud

  • Create Invoice Adjustment Crud

  • Create Invoice Payment Crud

  • Create Journal Run

  • Create Payment

  • Create Payment Crud

  • Create Payment Method

  • Create Payment Method Crud

  • Create Payment Run

  • Create Product Crud

  • Create Product Rate Plan Crud

  • Create Refund Crud

  • Create Revenue Schedule For Credit Memo Item Distribute By Date Range

  • Create Revenue Schedule For Credit Memo Item Manual Distribution

  • Create Revenue Schedule For Debit Memo Item Distribute By Date Range

  • Create Revenue Schedule For Debit Memo Item Manual Distribution

  • Create Revenue Schedule For Invoice Item Adjustment Distribute By Date Range

  • Create Revenue Schedule For Invoice Item Adjustment Manual Distribution

  • Create Revenue Schedule For Invoice Item Distribute By Date Range

  • Create Revenue Schedule For Invoice Item Manual Distribution

  • Create Revenue Schedule On Subscription Charge

  • Create Subscription

  • Create Summary Journal Entry

  • Create Taxation Item Crud

  • Create Taxation Items For Credit Memo

  • Create Taxation Items For Debit Memo

  • Create Unit Of Measure Crud

  • Create Usage Crud

  • Deactivate Accounting Code

  • Decrypt Rsa Signature

  • Delete

  • Delete Account Crud

  • Delete Accounting Code

  • Delete Accounting Period

  • Delete Amendment Crud

  • Delete Attachments

  • Delete Bill Run Crud

  • Delete Contact Crud

  • Delete Credit Memo

  • Delete Debit Memo

  • Delete Entity Multi Entity

  • Delete Feature Crud

  • Delete Invoice Adjustment Crud

  • Delete Invoice Crud

  • Delete Invoice Item Adjustment Crud

  • Delete Journal Run

  • Delete Order

  • Delete Payment

  • Delete Payment Crud

  • Delete Payment Method

  • Delete Payment Method Crud

  • Delete Payment Method Snapshot Crud

  • Delete Payment Run

  • Delete Product Crud

  • Delete Product Feature Crud

  • Delete Product Rate Plan Charge Crud

  • Delete Product Rate Plan Crud

  • Delete Refund

  • Delete Refund Crud

  • Delete Revenue Schedule

  • Delete Subscription Crud

  • Delete Summary Journal Entry

  • Delete Taxation Item

  • Delete Taxationitem Crud

  • Delete Unitofmeasure Crud

  • Delete Usage Crud

  • Deny Connection Multi Entity

  • Deny User Access Multi Entity

  • Describe Object

  • Disconnect Connection Multi Entity

  • Distribute Revenue Across Accounting Periods

  • Distribute Revenue By Recognition Start And End Dates

  • Distribute Revenue On Specific Date

  • Edit Attachments

  • Email Billing Documents Generated From Bill Run

  • Email Credit Memo

  • Email Debit Memo

  • Email Invoice

  • Establish Connection To Zuora Rest Api Service

  • Execute

  • Generate

  • Generate An Oauth Token

  • Generate Billing Documents By Account

  • Generate Quotes Document

  • Generate Rsa Signature

  • Get Account

  • Get Account Summary

  • Get Accounting Period

  • Get All Accounting Codes

  • Get All Accounting Periods

  • Get All Orders

  • Get All Payments

  • Get All Refunds

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

  • Get All Summary Journal Entries In A Journal Run

  • Get Amendment Crud

  • Get Amendments By Key

  • Get Amendments By Subscription Id

  • Get An Order

  • Get Billing Documents

  • Get Billing Information For Order

  • Get Billing Preview Run

  • Get Breakdown Of Credit Memo By Order

  • Get Breakdown Of Invoice By Order

  • Get Callout Notification Histories

  • Get Charge Summary Details By Charge Id

  • Get Charge Summary Details By Crs Number

  • Get Connections Multi Entity

  • Get Credit Memo

  • Get Credit Memo Item

  • Get Credit Memo Items

  • Get Credit Memo Part

  • Get Credit Memo Part Item

  • Get Credit Memo Part Items

  • Get Credit Memo Parts

  • Get Credit Memos

  • Get Custom Foreign Currency Exchange Rates

  • get debit Memo

  • get debit Memo Application Parts

  • get debit Memo Item

  • get debit Memo Items

  • get debit Memos

  • Get Email Notification Histories

  • Get Entities Multi Entity

  • Get Entities That A User Can Access Multi Entity

  • Get Entity By Id Multi Entity

  • Get Files

  • Get Invoice Application Parts

  • Get Invoices

  • Get Journal Run

  • Get Mass Action Result

  • Get Order Metrics For Evergreen Subscription

  • Get Orders By Invoice Owner

  • Get Orders By Subscription Number

  • Get Orders By Subscription Owner

  • Get Payment

  • Get Payment Crud

  • Get Payment Gateways

  • Get Payment Method Crud

  • Get Payment Methods

  • Get Payment Part

  • Get Payment Part Item

  • Get Payment Part Items

  • Get Payment Parts

  • Get Payment Run

  • Get Payment Run Summary

  • Get Payment Runs

  • Get Payment Transaction Log Crud

  • Get Payments

  • Get Product Catalog

  • Get Rated Result For Order

  • Get Refund

  • Get Refund Crud

  • Get Refund Part

  • Get Refund Part Item

  • Get Refund Part Items

  • Get Refund Parts

  • Get Revenue Event Details

  • Get Revenue Events For A Revenue Schedule

  • Get Revenue Items By Charge Revenue Summary Number

  • Get Revenue Items By Revenue Event Number

  • Get Revenue Items By Revenue Schedule

  • Get Revenue Recognition Rule By Product Rate Plan Charge

  • Get Revenue Recognition Rule By Subscription Charge

  • Get Revenue Schedule By Credit Memo Item Id

  • Get Revenue Schedule By Debit Memo Item Id

  • Get Revenue Schedule By Invoice Item Adjustment

  • Get Revenue Schedule By Invoice Item Id

  • Get Revenue Schedule By Subscription Charge

  • Get Revenue Schedule Details

  • Get Subscriptions By Account

  • Get Subscriptions By Key

  • Get Subscriptions By Key And Version

  • Get Summary Journal Entry

  • Get Taxation Item

  • Get Term Information For Subscription

  • Get The Revenue Automation Start Date

  • Get Usage

  • Initiate Connection Multi Entity

  • Invoice And Collect

  • Perform Mass Action

  • Post Credit Memo

  • Post Debit Memo

  • Post Or Cancel Bill Run Crud

  • Post Usage

  • Preview Order

  • Preview Subscription

  • Provision Entity Multi Entity

  • Query

  • Query An Accounting Code

  • Query More

  • Re Open Accounting Period

  • Refund Credit Memo

  • Refund Payment

  • Renew Subscription

  • Resume Subscription

  • Retrieve Account Crud

  • Retrieve Bill Run Crud

  • Retrieve Communication Profile Crud

  • Retrieve Contact Crud

  • Retrieve Credit Balance Adjustment Crud

  • Retrieve Export Crud

  • Retrieve Feature Crud

  • Retrieve Import Crud

  • Retrieve Invoice Adjustment Crud

  • Retrieve Invoice Crud

  • Retrieve Invoice Item Adjustment Crud

  • Retrieve Invoice Item Crud

  • Retrieve Invoice Payment Crud

  • Retrieve Invoice Split Crud

  • Retrieve Invoice Split Item Crud

  • Retrieve Payment Method Transaction Log Crud

  • Retrieve Paymentmethodsnapshot Crud

  • Retrieve Product Crud

  • Retrieve Product Feature Crud

  • Retrieve Product Rate Plan Charge Crud

  • Retrieve Product Rate Plan Charge Tier Crud

  • Retrieve Product Rate Plan Crud

  • Retrieve Rate Plan Charge Crud

  • Retrieve Rate Plan Charge Tier Crud

  • Retrieve Rateplan Crud

  • Retrieve Refund Invoice Payment Crud

  • Retrieve Refund Transaction Log Crud

  • Retrieve Subscription Crud

  • Retrieve Subscription Product Feature Crud

  • Retrieve Taxation Item Crud

  • Retrieve Unit Of Measure Crud

  • Retrieve Usage Crud

  • Return Hmac Signatures

  • Return Hosted Pages

  • Reverse Invoice

  • Run Trial Balance

  • Send User Access Requests Multi Entity

  • Set Accounting Period To Pending Close

  • Share A Product With An Entity Multi Entity

  • Stop Mass Action

  • Subscribe

  • Suspend Subscription

  • Transfer Payment

  • Unapply Credit Memo

  • Unapply Payment

  • Update Account

  • Update Account Crud

  • Update Accounting Period

  • Update Amendment Crud

  • Update An Accounting Code

  • Update Basic Information Of A Summary Journal Entry

  • Update Contact Crud

  • Update Credit Memo

  • Update Custom Fields On Revenue Items By Revenue Event Number

  • Update Custom Fields On Revenue Items By Revenue Schedule Number

  • Update Debit Memo

  • Update Debit Memos

  • Update Entity Multi Entity

  • Update Invoice

  • Update Invoice Adjustment Crud

  • Update Invoice Crud

  • Update Invoice Payment Crud

  • Update Invoices

  • Update Order Custom Fields

  • Update Payment

  • Update Payment Crud

  • Update Payment Method

  • Update Payment Method Crud

  • Update Payment Run

  • Update Product Crud

  • Update Product Rate Plan Crud

  • Update Refund

  • Update Refund Crud

  • Update Revenue Schedule Basic Information

  • Update Subscription

  • Update Subscription Crud

  • Update Subscription Custom Fields

  • Update Taxation Item

  • Update Taxation Item Crud

  • Update Unit Of Measure Crud

  • Update Usage Crud

  • Verify Payment Method

  • View Attachments List

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-Entityenabled 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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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]

Description

String

Description of the attachment document.

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

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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, 4a2424b2424242c42424d424242e4242.

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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, 4a2424b2424242c42424d424242e4242.

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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, 4a2424b2424242c42424d424242e4242.

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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, 4a2424b2424242c42424d424242e4242.

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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, 4a2424b2424242c42424d424242e4242.

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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, 4a2424b2424242c42424d424242e4242.

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 the following fields: * invoice * collect * 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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 the following fields: * invoice * collect * 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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Create Amendment Crud

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

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create Amendment 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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Create And Activate Order

<mule-zuora-connector:create-and-activate-order>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Create And Activate Order 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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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, 4a2424b2424242c42424d424242e4242.

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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, 4a2424b2424242c42424d424242e4242.

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 the following fields: * invoice * collect * 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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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, 4a2424b2424242c42424d424242e4242.

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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, 4a2424b2424242c42424d424242e4242.

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Delete Attachments

<mule-zuora-connector:delete-attachments>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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, 4a2424b2424242c42424d424242e4242.

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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, 4a2424b2424242c42424d424242e4242.

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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, 4a2424b2424242c42424d424242e4242.

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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

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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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, 4a2424b2424242c42424d424242e4242.

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Delete Taxationitem Crud

<mule-zuora-connector:delete-taxationitem-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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Delete Unitofmeasure Crud

<mule-zuora-connector:delete-unitofmeasure-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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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.

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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]

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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, 4a2424b2424242c42424d424242e4242.

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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, 4a2424b2424242c42424d424242e4242.

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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

Content Type

String

Must be set to "application/json"

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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]

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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

Fields Filterable

String

This parameter restricts the data returned in the response. You can use this parameter to supply a dimension you want to filter on. A single filter uses the following form: fieldsFilterable = field_value Filters can be combined by using &. For example: fieldsFilterable = field_value & fieldsFilterable = field_value fieldsFilterable indicates the name of a supported field that you can use to filter the response data. The supported filterable fields of this operation are as below: - number - status - type - accountId - amount - appliedAmount - unappliedAmount - refundAmount - creditBalanceAmount - currency - effectiveDate - createdDate - createdById - updatedDate - updatedById field_value indicates a valid value of the filterable field. If the type of the field value is string, you can set the field to null value for filtering. Then, you can get the response data with this field value being 'null'. For more information about these fields, see the field descriptions in the Responses section. Examples: - /payments?status=Processed - /payments?currency=USD&status=Processed - /payments?status=Processed&type=External&sort=+number

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 is displayed in descending order by payment number. field_name indicates the name of a sortable field. The supported sortable fields of this operation are as below: - number - accountId - amount - appliedAmount - unappliedAmount - refundAmount - creditBalanceAmount - effectiveDate - createdDate - createdById - updatedDate - updatedById Examples: - /payments?sort=+number - /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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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

Fields Filterable

String

This parameter restricts the data returned in the response. You can use this parameter to supply a dimension you want to filter on. A single filter uses the following form: fieldsFilterable = field_value Filters can be combined by using &. For example: fieldsFilterable = field_value & fieldsFilterable = field_value fieldsFilterable indicates the name of a supported field that you can use to filter the response data. The supported filterable fields of this operation are as below: - number - status - type - accountId - amount - refundDate - paymentId - createdDate - createdById - updatedDate - updatedById - methodType field_value indicates a valid value of the filterable field. If the type of the field value is string, you can set the field to null value for filtering. Then, you can get the response data with this field value being 'null'. For more information about these fields, see the field descriptions in the Responses section. Examples: - /refunds?status=Processed - /refunds?amount=4&status=Processed - /refunds?status=Processed&type=External&sort=+number

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 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 as below: - number - accountId - amount - refundDate - paymentId - createdDate - createdById - updatedDate - updatedById Examples: - /refunds?sort=+number - /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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

Get Amendment Crud

<mule-zuora-connector:get-amendment-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.

Target Variable

String

The variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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. If you do not specify any sortable field, the response data is sorted by the documentDate field in descending order. 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. field_name indicates the name of a sortable field. The supported sortable fields of this operation are as below: - 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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 for the order are calculated as of this date. Invoices with the invoice date later than this date are not counted in 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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 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 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.

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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, 424242424a242424242b424c42424242.

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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, 4a2424b2424242c42424d424242e4242.

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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, 4a2424b2424242c42424d424242e4242.

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 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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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

Fields Filterable

String

This parameter restricts the data returned in the response. You can use this parameter to supply a dimension you want to filter on. A single filter uses the following form: fieldsFilterable = field_value Filters can be combined by using &. For example: fieldsFilterable = field_value & fieldsFilterable = field_value fieldsFilterable indicates the name of a supported field that you can use to filter the response data. The supported filterable fields of this operation are as below: - id - amount - appliedAmount - refundAmount - sku - skuName - serviceStartDate - serviceEndDate - sourceItemId - createdDate - createdById - updatedDate - updatedById - subscriptionId field_value indicates a valid value of the filterable field. If the type of the field value is string, you can set the field to null value for filtering. Then, you can get the response data with this field value being 'null'. For more information about these fields, see the field descriptions in the Responses section. Examples: - /creditmemos/402890245c7ca371015c7cb40ac30015/items?amount=100 - /creditmemos/402890245c7ca371015c7cb40ac30015/items?amount=100&sort=createdDate

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 is displayed in descending order by updated date. field_name indicates the name of a sortable field. The supported sortable fields of this operation are as below: - id - amount - appliedAmount - refundAmount - sku - skuName - serviceStartDate - serviceEndDate - sourceItemId - createdDate - createdById - updatedDate - updatedById - subscriptionId Examples: - /creditmemos/402890245c7ca371015c7cb40ac30015/items?sort=createdDate - /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, 4a2424b2424242c42424d424242e4242.

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 variable that stores the operation’s output.

Target Value

String

Evaluate this expression against the operation’s output and store the results in the target variable.

#[payload]

Output

Type

Any

For Configurations

  • config

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, 4a2424b2424242c42424d424242e4242.