Contact Free trial Login

Zuora - Upgrade and Migrate - Mule 4

Upgrade Anypoint Connector for Zuora (Zuora Connector) to version 6.0.0.

Supported Upgrade Paths

From Version To Version

5.x.x

6.0.0

Changes in This Release

This release contains new and changed operations, metadata, fields, and values.

New Operations

Zuora Connector 6.0.0 includes the following new operations:

New in Zuora 6.0.0

Name

Description

Generate an OAuth token

Generates a bearer token that enables an OAuth client to authenticate with the Zuora REST API.

Object POSTFeature

This operation makes an HTTP POST request to the /v1/object/feature endpoint

Get workflow task usage

Gets workflow task usage sorted by day within a specified time frame.

Object PUTFeature

This operation makes an HTTP PUT request to the /v1/object/feature/{id} endpoint

PUT Rev Pro Accounting Codes

Update the Zuora Revenue accounting code that corresponds to a specific Product Rate Plan Charge Id in Zuora Billing.

Update subscription custom fields of a specified subscription version

Updates the custom fields of a specified subscription version.

Removed Operations

The following operations were removed in Zuora Connector 6.0.0:

Removed in Zuora 6.0.0

Name

Description

Import usage file

This operation makes an HTTP POST request to the /usage-imports endpoint

Create usage records

This operation makes an HTTP POST request to the /usage endpoint

Request breakdown of credit memo items by order

Retrieves specified credit memo items which are broken down by orders.

Request breakdown of invoice items by order

Retrieves the specified invoice items which are broken down by orders.

Delete schema of Usage custom field definition

This operation makes an HTTP DELETE request to the /fields/definitions/Usage endpoint

CRUD: Delete payment method snapshot

This REST API reference describes how to delete a Payment Method Snapshot.

Get Usage custom field definition

This operation makes an HTTP GET request to the /fields/definitions/Usage endpoint

Get rating results by account

This operation makes an HTTP GET request to the /rating/rated-results/account/{accountNumber} endpoint

Get rating results by charge

This operation makes an HTTP GET request to the /rating/rated-results/charge/{chargeNumber} endpoint

Get rating results by subscription

This operation makes an HTTP GET request to the /rating/rated-results/subscription/{subscriptionNumber} endpoint

Get rated usage by account

This operation makes an HTTP GET request to the /rating/rated-usages/account/{accountNumber} endpoint

Get rated usage by charge

This operation makes an HTTP GET request to the /rating/rated-usages/charge/{chargeNumber} endpoint

Get rated usage by subscription

This operation makes an HTTP GET request to the /rating/rated-usages/subscription/{subscriptionNumber} endpoint

Get status of usage import

Get details of usage import

Download usage import failure file

This operation makes an HTTP GET request to the /usage-imports/{id}/errors endpoint

Download usage import file

This operation makes an HTTP GET request to the /usage-imports/{id}/import-file endpoint

Get status of usage import

This operation makes an HTTP GET request to the /usage-imports/{id}/status endpoint

Download usage file template

This operation makes an HTTP GET request to the /usage-imports/templates/html endpoint

Query usage records in stream

This operation makes an HTTP GET request to the /usage/stream-query endpoint

Get breakdown of credit memo by order

Retrieves a specified credit memo that is broken down by orders. One credit memo item might be broken down into a list of order related items.

Get breakdown of invoice by order

Retrieves a specified invoice that is broken down by orders. One invoice item might be broken down into a list of order related items.

Get rated result for order

Retrieves the rated results of all the subscriptions in the specified order.

Set schema of Usage custom field definition

This operation makes an HTTP PUT request to the /fields/definitions/Usage endpoint

Update usage record

Updates certain information of a specified usage record.

Changes in Operations Parameters

The following changes were made to these operations:

Existing in Zuora 5.x Modified in Zuora 6.x

Operation Name

Input Params

Output Params

Operation Name

Input Params

Output Params

Create Credit Memo From Charge

N/A

N/A

Create Credit Memo From Charge

N/A

taxStatus (Added) taxMessage (Added)

Get Credit Memo

N/A

N/A

Get Credit Memo

N/A

taxStatus (Added) taxMessage (Added)

Update Credit Memo

N/A

N/A

Update Credit Memo

N/A

taxStatus (Added) taxMessage (Added)

Apply Credit Memo

N/A

N/A

Apply Credit Memo

N/A

taxStatus (Added) taxMessage (Added)

Unapply Credit Memo

N/A

N/A

Unapply Credit Memo

N/A

taxStatus (Added) taxMessage (Added)

Cancel Credit Memo

N/A

N/A

Cancel Credit Memo

N/A

taxStatus (Added) taxMessage (Added)

Post Credit Memo

N/A

N/A

Post Credit Memo

N/A

taxStatus (Added) taxMessage (Added)

Unpost Credit Memo

N/A

N/A

Unpost Credit Memo

N/A

taxStatus (Added) taxMessage (Added)

Get Credit Memos

N/A

N/A

Get Credit Memos

N/A

taxStatus (Added under creditmemos) taxMessage (Added under creditmemos)

Create Debit Memo From Charge

N/A

N/A

Create Debit Memo From Charge

accountNumber (Added) (conditionally required) accountId (conditionally required)

N/A

Create Debit Memo From Charge

N/A

N/A

Create Debit Memo From Charge

N/A

taxStatus (Added) taxMessage (Added)

Get Debit Memo

N/A

N/A

Get Debit Memo

N/A

taxStatus (Added) taxMessage (Added)

Update Debit Memo

N/A

N/A

Update Debit Memo

N/A

taxStatus (Added) taxMessage (Added)

Cancel Debit Memo

N/A

N/A

Cancel Debit Memo

N/A

taxStatus (Added) taxMessage (Added)

Post Debit Memo

N/A

N/A

Post Debit Memo

N/A

taxStatus (Added) taxMessage (Added)

Unpost Debit Memo

N/A

N/A

Unpost Debit Memo

N/A

taxStatus (Added) taxMessage (Added)

Get Debit Memos

N/A

N/A

Get Debit Memos

N/A

taxStatus (Added under debitmemos) taxMessage (Added under debitmemos)

Create Credit Memo From Invoice

N/A

N/A

Create Credit Memo From Invoice

items (Added under quantity)

taxStatus (Added) taxMessage (Added)

Create Debit Memo From Invoice

N/A

N/A

Create Debit Memo From Invoice

items (Added under quantity)

taxStatus (Added) taxMessage (Added)

Submit Data Query

outputFormat (JSON)

N/A

Submit Data Query

TSV (Added under outputFormat) DSV (Added under outputFormat) outputFormat (JSONL) columnSeparator (Added) useIndexJoin (Added) readDeleted (Added)

N/A

Create Subscription

N/A

N/A

Create Subscription

gatewayId (Added) paymentMethodId (Added)

N/A

Cancel Authorization

accountId accountNumber

N/A

Cancel Authorization

paymentGatewayId (Added) (Optional) accountId (Modified) (Optional) accountNumber (Modified) (Optional)

N/A

Return Hosted Pages

pageSize nextPage

N/A

Return Hosted Pages

pageSize (Removed) nextPage (Removed)

N/A

Preview Order

N/A

N/A

Preview Order

description (Added) paymentMethod (Added under newSubscriptionOwnerAccount) chargeModelData (Added under various fields)

N/A

Preview Order Asynchronously

N/A

N/A

Preview Order Asynchronously

description (Added) paymentMethod (Added under newSubscriptionOwnerAccount) chargeModelData (Added under various fields)

N/A

Create Order

N/A

N/A

Create Order

description (Added) paymentMethod (Added to various fields) chargeModelData (Added under various fields)

N/A

Create Order Asynchronously

N/A

N/A

Create Order Asynchronously

description (Added) paymentMethod (Added to various fields) chargeModelData (Added under various fields)

N/A

Get All Orders

N/A

N/A

Get All Orders

description (Added under orders) paymentMethod (Added under newSubscriptionOwnerAccount) chargeModelData (Added under pricing)

N/A

Get Orders By Subscription Owner

N/A

N/A

Get Orders By Subscription Owner

description (Added under orders) paymentMethod (Added under newSubscriptionOwnerAccount) chargeModelData (Added under pricing)

N/A

Get Orders By Subscription Number

N/A

N/A

Get Orders By Subscription Number

description (Added under orders) paymentMethod (Added under newSubscriptionOwnerAccount) chargeModelData (Added under pricing)

N/A

Get Orders By Invoice Owner

N/A

N/A

Get Orders By Invoice Owner

description (Added under orders) paymentMethod (Added under newSubscriptionOwnerAccount) chargeModelData (Added under pricing)

N/A

Get An Order

N/A

N/A

Get An Order

description (Added under order) paymentMethod (Added under newSubscriptionOwnerAccount) chargeModelData (Added under pricing)

N/A

Get Order Metrics For Evergreen Subscription

N/A

N/A

Get Order Metrics For Evergreen Subscription

description (Added under order) paymentMethod (Added under newSubscriptionOwnerAccount) chargeModelData (Added under pricing)

N/A

Create Account

N/A

N/A

Create Account

paymentMethod (Added)

N/A

Create Payment Method

N/A

N/A

Create Payment Method

IBAN (Added) businessIdentificationCode (Added) accountNumber (Added) identityNumber (Added) bankCode (Added) branchCode (Added) SEPA (Added under type) Betalingsservice (Added under type) Autogiro (Added under type) Bacs (Added under type)

N/A

Query Custom Object Records

N/A

N/A

Query Custom Object Records

ids (Added query parameter)

N/A

Update invoices

N/A

N/A

Update invoices

invoiceDate (Added under invoices)

N/A

Crud: Post or Cancel Build Run

N/A

N/A

Crud: Post or Cancel Build Run

invoiceDate (Added)

N/A

Create Sequence Set

N/A

N/A

Create Sequence Set

payment (Added under sequenceSets) refund (Added under sequenceSets)

payment (Added under sequenceSets) refund (Added under sequenceSets)

Update Sequence Set

N/A

N/A

Update Sequence Set

payment (Added) refund (Added)

N/A

Get Sequence Set

N/A

N/A

Get Sequence Set

N/A

payment (Added under sequenceSets) refund (Added under sequenceSets)

Get Sequence Set

N/A

N/A

Get Sequence Set

N/A

payment (Added under sequenceSets) refund (Added under sequenceSets)

Update Custom Object Definition

N/A

N/A

Update Custom Object Definition

required (Added) Zuora-Version (Added header parameter)

required (Added)

Get All Custom Object Definitions

N/A

N/A

Get All Custom Object Definitions

Zuora-Version (Added header parameter)

filterable (Added)

Create Custom Object Definition

N/A

N/A

Create Custom Object Definition

filterable (Added) Zuora-Version (Added header parameter)

filterable (Added)

Get Custom Object Definition

N/A

N/A

Get Custom Object Definition

Zuora-Version (Added header parameter)

filterable (Added)

Delete Custom Object Definition

N/A

N/A

Delete Custom Object Definition

Zuora-Version (Added header parameter)

N/A

Create Custom Object Records

N/A

N/A

Create Custom Object Records

Zuora-Version (Added header parameter)

N/A

Query Custom Object Records

N/A

N/A

Query Custom Object Records

Zuora-Version (Added header parameter)

N/A

Get Custom Object Record

N/A

N/A

Get Custom Object Record

Zuora-Version (Added header parameter)

N/A

Update Custom Object Record

N/A

N/A

Update Custom Object Record

Zuora-Version (Added header parameter)

N/A

Update Individual Fields In A Custom Object Record

N/A

N/A

Update Individual Fields In A Custom Object Record

Zuora-Version (Added header parameter)

N/A

Delete Custom Object Record

N/A

N/A

Delete Custom Object Record

Zuora-Version (Added header parameter)

N/A

Update Or Delete Custom Object Records As A Batch

N/A

N/A

Update Or Delete Custom Object Records As A Batch

Zuora-Version (Added header parameter)

N/A

Update Invoice

N/A

N/A

Update Invoice

invoiceDate (Added)

N/A

Refund Credit Memo

N/A

N/A

Refund Credit Memo

gatewayOptions (Added)

N/A

Refund Payment

N/A

N/A

Refund Payment

gatewayOptions (Added)

N/A

Preview Subscription

N/A

N/A

Preview Subscription

chargeModelConfiguration (Added under chargeOverrides)

N/A

Create Subscription

N/A

N/A

Create Subscription

chargeModelConfiguration (Added under chargeOverrides)

N/A

Update Subscription

N/A

N/A

Update Subscription

chargeModelConfiguration (Added under chargeOverrides and chargeUpdateDetails)

N/A

Get Subscription By Account

N/A

N/A

Get Subscription By Account

chargeModelConfiguration (Added under ratePlanCharges)

N/A

Get Subscriptions By Key

N/A

N/A

Get Subscriptions By Key

chargeModelConfiguration (Added under ratePlanCharges)

N/A

Get Subscriptions By Key And Version

N/A

N/A

Get Subscriptions By Key And Version

chargeModelConfiguration (Added under ratePlanCharges)

N/A

All Actions Operations

N/A

N/A

All Actions Operations

rejectUnknownFields (Added queryParameter)

N/A

All Crud Post Operations

N/A

N/A

All Crud Post Operations

rejectUnknownFields (Added queryParameter)

N/A

All Crud Put Operations

N/A

N/A

All Crud Put Operations

rejectUnknownFields (Added queryParameter)

N/A

Upgrade Prerequisites

Before you perform the upgrade, you must:

  1. Create a backup of your files, data, and configuration in case you need to restore to the previous version.

  2. Install Zuora Connector to replace the Zuora operations that were previously included in Zuora Connector 5.x.x.

Upgrade Steps

Follow these steps to perform the upgrade to Zuora Connector 6.0.0:

  1. In Studio, create a Mule project.

  2. In the Mule Palette view, click Search in Exchange.

  3. In Add Modules to Project, type 'Zuora' in the search field.

  4. In Available modules, select Zuora Connector, and then click Add.

  5. Click Finish.

  6. Verify that the zuora-connector dependency version is 6.0.0 in the pom.xml.

Anypoint Studio upgrades the connector automatically.

Verify the Upgrade

After you install the latest version of the connector, follow these steps to verify the upgrade:

  1. In Anypoint Studio, verify that there are no errors in the Problems or Console views.

    • If you’re running the app from Anypoint Platform, the output is visible in the Anypoint Studio console window.

    • If you’re running the app using Mule from the command line, the app log is visible in your OS console.

      Unless the log file path is customized in the app’s log file (log4j2.xml), you can also view the app log in the default location MULE_HOME/logs/<app-name>.log.

  2. Check the project pom.xml and verify that there are no problems.

  3. Test the connection and verify that the operations work.

Troubleshooting

If there are problems with caching the parameters and caching the metadata, try restarting Anypoint Studio.

Reverting the Upgrade

If it is necessary to revert to the previous version of Zuora Connector, change the zuora-connector dependency version 6.0.0 in the project’s pom.xml to the previous version.

You must update the project’s pom.xml in Anypoint Studio.