4.2.x
Zuora - Upgrade and Migrate - Mule 4
Upgrade Anypoint Connector for Zuora (Zuora Connector) to version 5.0.0.
Changes in This Release
This release contains the following changes:
-
Changed operation names, metadata, fields, and values
-
AQuA operations are removed from Zuora Connector. To use AQuA operations, install Zuora AQuA Connector.
Changes in Operations Parameters
Existing in Zuora 4.x | Modified in Zuora 5.x | ||||
---|---|---|---|---|---|
Operation Name |
Input Params |
Output Params |
Operation Name |
Input Params |
Output Params |
Get Account Crud |
|
N/A |
CRUD: Get account |
|
Attributes Type (HttpResponseAttributes) (New) |
Get Payment Crud |
Id (String) |
N/A |
CRUD: Get payment |
id (String) (Modified) |
Attributes Type (HttpResponseAttributes) (New) |
Get Payment Method Crud |
|
N/A |
CRUD: Get payment method |
|
Attributes Type (HttpResponseAttributes) (New) |
Get Payment Method Snapshot Crud |
|
N/A |
CRUD: Get payment method snapshot |
|
Attributes Type (HttpResponseAttributes) (New) |
Get Payment Transaction Log Crud |
Id (String) |
N/A |
CRUD: Get payment transaction log |
id (String) (Modified) |
Attributes Type (HttpResponseAttributes) (New) |
Get Refund Crud |
|
N/A |
CRUD: Get refund |
|
Attributes Type (HttpResponseAttributes) (New) |
Get A Notification Definition |
Id (String) |
N/A |
No changes |
id (String) (Modified) |
Attributes Type (HttpResponseAttributes) (New) |
Get Account |
Account Key (String) |
N/A |
No changes |
Account key (String) (Modified) |
Attributes Type (HttpResponseAttributes) (New) |
Get Account Summary |
Account Key (String) |
N/A |
No changes |
Account key (String) (Modified) |
Attributes Type (HttpResponseAttributes) (New) |
Get Accounting Period |
Account Id (String) |
N/A |
No changes |
Ap id (String) (Modified) |
Attributes Type (HttpResponseAttributes) (New) |
Create Account |
Create Accounting Request Data(Any) |
N/A |
No changes |
|
Type (HttpResponseAttributes) (New) |
Create accounting period |
Create Accounting Period Request Data (Any) |
N/A |
No changes |
|
Type (HttpResponseAttributes) (New) |
Create Account Crud |
Create Account Crud Request Data (Any) |
N/A |
CRUD: Create account |
|
Type (HttpResponseAttributes) (New) |
Create Accounting Code |
Create Accounting Code Request Data (Any) |
N/A |
No changes |
|
Type (HttpResponseAttributes) (New) |
Create An Email Template |
Create An Email Template Request Data (Any) |
N/A |
No changes |
|
Type (HttpResponseAttributes) (New) |
Update Credit Balance Adjustment Crud |
|
N/A |
CRUD: Update CreditBalanceAdjustment |
|
Attributes Type (HttpResponseAttributes) (New) |
Update Invoice Adjustment Crud |
|
N/A |
CRUD: Update InvoiceAdjustment |
|
Attributes Type (HttpResponseAttributes) (New) |
Update Invoice Payment Crud |
|
N/A |
CRUD: Update InvoicePayment |
|
Attributes Type (HttpResponseAttributes) (New) |
Update Product Crud |
|
N/A |
CRUD: Update Product |
|
Attributes Type (HttpResponseAttributes) (New) |
Update Product Rate Plan Crud |
|
N/A |
CRUD: Update ProductRatePlan |
|
Attributes Type (HttpResponseAttributes) (New) |
Update Product Rate Plan Charge Crud |
|
N/A |
CRUD: Update ProductRatePlanChargeTier |
|
Attributes Type (HttpResponseAttributes) (New) |
Update Subscription Crud |
|
N/A |
CRUD: Update Subscription |
|
Attributes Type (HttpResponseAttributes) (New) |
Update Taxation Item Crud |
|
N/A |
CRUD: CRUD: Update Taxation Item |
|
Attributes Type (HttpResponseAttributes) (New) |
Update Subscription Crud |
|
N/A |
CRUD: Update Subscription |
|
Attributes Type (HttpResponseAttributes) (New) |
Update Account Crud |
|
N/A |
CRUD: Update Account |
|
Attributes Type (HttpResponseAttributes) (New) |
Update Unit Of Measure Crud |
|
N/A |
CRUD: Update UnitOfMeasure |
|
Attributes Type (HttpResponseAttributes) (New) |
Update Amendment Crud |
|
N/A |
CRUD: Update amendment |
|
Attributes Type (HttpResponseAttributes) (New) |
Update Contact Crud |
|
N/A |
CRUD: Update contact |
|
Attributes Type (HttpResponseAttributes) (New) |
Update Refund Crud |
|
N/A |
CRUD: Update refund |
|
Attributes Type (HttpResponseAttributes) (New) |
Update Usage Crud |
|
N/A |
CRUD: Update usage |
|
Attributes Type (HttpResponseAttributes) (New) |
Update Invoice Crud |
|
N/A |
CRUD: Update Invoice |
|
Attributes Type (HttpResponseAttributes) (New) |
Update Entity Multi Entity |
|
N/A |
Multi-entity: Update entity |
|
Attributes Type (HttpResponseAttributes) (New) |
Update |
Update Request Data (Any) |
N/A |
No changes |
|
Attributes Type (HttpResponseAttributes) (New) |
Update A Notification Definition |
|
N/A |
No changes |
|
Attributes Type (HttpResponseAttributes) (New) |
Update Account |
Update Account Request Data (Any) |
N/A |
No changes |
|
Attributes Type (HttpResponseAttributes) (New) |
Update Accounting Period |
|
N/A |
No changes |
|
Attributes Type (HttpResponseAttributes) (New) |
Update An Accounting Code |
|
N/A |
No changes |
|
Attributes Type (HttpResponseAttributes) (New) |
Update An Email Template |
|
N/A |
No changes |
|
Attributes Type (HttpResponseAttributes) (New) |
Update Basic Information Of A Summary Journal Entry |
Update Basic Information Of A Summary Journal Entry Request Data (Any) |
N/A |
No changes |
|
Attributes Type (HttpResponseAttributes) (New) |
Update Credit Card Payment Method |
|
N/A |
No changes |
|
Attributes Type (HttpResponseAttributes) (New) |
Update Credit Memo |
Update Credit Memo Request Data (Any) |
N/A |
No changes |
|
Attributes Type (HttpResponseAttributes) (New) |
Update Custom Fields On Revenue Items By Revenue Event Number |
|
N/A |
No changes |
|
Attributes Type (HttpResponseAttributes) (New) |
Update Custom Fields On Revenue Items By Revenue Schedule Number |
|
N/A |
No changes |
|
Attributes Type (HttpResponseAttributes) (New) |
Update Debit Memo |
Update Debit Memo Request Data (Any) |
N/A |
No changes |
|
Attributes Type (HttpResponseAttributes) (New) |
Update Debit Memos |
Update Debit Memos Request Data (Any) |
N/A |
No changes |
|
Attributes Type (HttpResponseAttributes) (New) |
Update Document Properties |
Update Document Properties Request Data (Any) |
N/A |
No changes |
|
Attributes Type (HttpResponseAttributes) (New) |
Update Invoice |
Update Invoice Request Data (Any) |
N/A |
No changes |
|
Attributes Type (HttpResponseAttributes) (New) |
Update Invoices |
Update Invoices Request Data (Any) |
N/A |
No changes |
|
Attributes Type (HttpResponseAttributes) (New) |
Update Order Action Trigger Dates |
Update Order Action Trigger Dates Request Data (Any) |
N/A |
No changes |
|
Attributes Type (HttpResponseAttributes) (New) |
Update Order Custom Fields |
Update Order Custom Fields Request Data (Any) |
N/A |
No changes |
|
Attributes Type (HttpResponseAttributes) (New) |
Changes in Operations Metadata
Metadata Existing in Zuora 4.x | Metadata in Zuora 5.x | ||||
---|---|---|---|---|---|
Operation Name |
Input Metadata |
Output Metadata |
Operation Name |
Input Metadata |
Output Metadata |
Submit data query |
N/A |
N/A |
POST Data Query Job |
|
N/A |
Create account |
|
N/A |
Create account |
|
N/A |
Amend |
N/A |
N/A |
Amend |
|
N/A |
Create account crud |
N/A |
N/A |
CRUD: Create account |
|
N/A |
Create credit balance adjustment crud |
N/A |
N/A |
CRUD: Create credit balance adjustment |
|
N/A |
Create import crud |
|
N/A |
CRUD: Create import |
|
N/A |
Create payment method crud |
MitProfileAgreedOn (String); |
N/A |
CRUD: Create payment method |
|
N/A |
Create payment crud |
N/A |
N/A |
CRUD: Create payment |
|
N/A |
Create product crud |
N/A |
N/A |
CRUD: Create product |
|
N/A |
Create product rate plan charge crud |
N/A |
N/A |
CRUD: Create product rate plan charge |
|
N/A |
Create product rate plan crud |
N/A |
N/A |
CRUD: Create product rate plan |
|
N/A |
Create refund crud |
N/A |
N/A |
CRUD: Create refund |
|
N/A |
Create usage crud |
N/A |
N/A |
CRUD: Create usage |
Description (String) (New) |
N/A |
Create order |
N/A |
N/A |
Create order |
N/A |
|
Create payment method |
N/A |
N/A |
CRUD: Create payment method |
|
N/A |
Create stored credential profile |
N/A |
N/A |
Create stored credential profile |
NetworkTransactionId (String) (New) |
N/A |
Cancel authorization |
N/A |
N/A |
Cancel authorization |
PaymentGatewayId (String) (New) |
N/A |
Create payment |
N/A |
N/A |
Create payment |
|
N/A |
Refund payment |
N/A |
N/A |
Refund payment |
|
|
Create subscription |
N/A |
|
Create subscription |
|
|
Post usage |
File (String) |
N/A |
Post usage |
File (String) (Removed) |
N/A |
Get account |
N/A |
N/A |
Get account |
N/A |
|
Get account summary |
N/A |
N/A |
Get account summary |
N/A |
|
Get Product |
N/A |
N/A |
Get Product |
N/A |
|
Get Product Catalog |
N/A |
N/A |
Get Product Catalog |
N/A |
|
Get credit memo |
N/A |
N/A |
Get credit memo |
N/A |
|
Get credit memo item |
N/A |
N/A |
Get credit memo item |
N/A |
Description(String)(New) |
Get credit memo items |
N/A |
N/A |
Get credit memo item |
N/A |
Description(String)(New) |
Get credit memos |
N/A |
N/A |
Get credit memos |
N/A |
TaxMessage(String)(New) * SyncDate_NS(String)(New) * Origin_NS(String)(New) * IntegrationStatus_NS(String)(New) * IntegrationId_NS(String)(New) * Transaction_NS(String)(New) |
Get debit memo |
N/A |
N/A |
Get debit memo |
N/A |
|
Get debit memo item |
N/A |
N/A |
Get debit memo item |
N/A |
Description(String)(New) |
Get debit memos |
N/A |
N/A |
Get debit memo item |
N/A |
|
Get invoice items |
N/A |
N/A |
Get invoice items |
N/A |
|
Get account crud |
N/A |
N/A |
CRUD: Get account |
N/A |
|
Retrieve Credit Balance Adjustment crud |
N/A |
N/A |
CRUD: Retrieve CreditBalanceAdjustment |
N/A |
|
Retrieve Invoice crud |
N/A |
N/A |
CRUD: Retrieve Invoice |
N/A |
|
Retrieve Invoice Item Adjustment crud |
N/A |
N/A |
CRUD: Retrieve InvoiceItemAdjustment |
N/A |
|
Retrieve Invoice Item crud |
N/A |
N/A |
CRUD: Retrieve InvoiceItem |
N/A |
|
Get payment crud |
N/A |
N/A |
CRUD: Get payment |
N/A |
|
Get payment method crud |
N/A |
N/A |
CRUD: Get payment method |
N/A |
BankTransferAccountNumber(String) (New) |
Retrieve product crud |
N/A |
N/A |
CRUD: Retrieve Product |
N/A |
|
Retrieve product rate plan crud |
N/A |
N/A |
CRUD: Retrieve Product Rate Plan |
N/A |
|
Retrieve product rate change plan crud |
N/A |
N/A |
CRUD: Get Product Rate Change Plan |
N/A |
|
Get refund |
N/A |
N/A |
Get refund |
N/A |
|
Retrieve subscription crud |
N/A |
N/A |
CRUD: Retrieve subscription |
N/A |
|
Retrieve usage crud |
N/A |
N/A |
CRUD: Get usage |
N/A |
SubscriptionNumber(String)(New) |
Get payment |
N/A |
N/A |
Get payment |
N/A |
|
Get all payments |
N/A |
N/A |
Get all payments |
N/A |
|
Get product rate plans |
N/A |
N/A |
Get product rate plans |
N/A |
|
Get refund |
N/A |
N/A |
Get refund |
N/A |
|
Get all refunds |
N/A |
N/A |
Get all refunds |
N/A |
|
Get subscriptions by account |
N/A |
N/A |
Get subscriptions by account |
N/A |
|
Get subscriptions by key |
N/A |
N/A |
Get subscriptions by key |
N/A |
|
Get subscriptions by key and version |
N/A |
N/A |
Get subscriptions by key and version |
N/A |
|
Get invoices |
N/A |
N/A |
Get invoices |
N/A |
|
Get payments |
N/A |
N/A |
Get payments |
N/A |
|
Update account |
N/A |
N/A |
Update account |
|
N/A |
Apply credit memo |
N/A |
N/A |
Apply credit memo |
N/A |
|
Update credit memo |
N/A |
N/A |
Update credit memo |
|
|
Cancel credit memo |
N/A |
N/A |
Cancel credit memo |
N/A |
|
Post credit memo |
N/A |
N/A |
Post credit memo |
N/A |
|
UnApply credit memo |
N/A |
N/A |
UnApply credit memo |
N/A |
|
UnPost credit memo |
N/A |
N/A |
UnPost credit memo |
N/A |
|
Update debit memo |
N/A |
N/A |
Update debit memo |
|
|
Cancel debit memo |
N/A |
N/A |
Cancel debit memo |
N/A |
|
Post debit memo |
N/A |
N/A |
Post debit memo |
N/A |
|
UnPost debit memo |
N/A |
N/A |
UnPost debit memo |
N/A |
|
Update invoice |
N/A |
N/A |
Update invoice |
N/A |
|
Update account crud |
N/A |
N/A |
CRUD: Update account |
N/A |
|
Update Credit Balance Adjustment crud |
N/A |
N/A |
CRUD: Update CreditBalanceAdjustment |
|
N/A |
Update payment crud |
N/A |
N/A |
CRUD: Update payment |
|
N/A |
Update product crud |
N/A |
N/A |
CRUD: Update product |
|
N/A |
Update product rate plan crud |
N/A |
N/A |
CRUD: Update ProductRatePlan |
|
N/A |
Update product rate plan charge crud |
N/A |
N/A |
CRUD: Update ProductRatePlanCharge |
|
N/A |
Update refund crud |
N/A |
N/A |
CRUD: Update refund |
|
N/A |
Update subscription crud |
N/A |
N/A |
CRUD: Update subscription |
|
N/A |
Apply payment |
N/A |
N/A |
Apply payment |
N/A |
|
Update payment |
N/A |
N/A |
Update payment |
|
|
Cancel payment |
N/A |
N/A |
Cancel payment |
N/A |
|
Transfer payment |
N/A |
N/A |
Transfer payment |
N/A |
|
UnApply payment |
N/A |
N/A |
UnApply payment |
N/A |
|
Update subscription |
N/A |
|
Update subscription |
|
|
Cancel refund |
N/A |
N/A |
Cancel refund |
N/A |
|
Update refund |
N/A |
N/A |
Update refund |
|
|
New Operations in Zuora Connector 5.0.0
Zuora Connector 5.0.0 includes the following new operations:
New in Zuora 5.x | |
---|---|
Name |
Description |
CRUD: Get amendment |
This operation makes an HTTP GET request to the |
CRUD: Get bill run |
Business operations that depend on the completion of the bill run are not available while the bill run query returns |
CRUD: Get contact |
This operation makes an HTTP GET request to the |
CRUD: Get invoice |
This operation makes an HTTP GET request to the |
CRUD: Get product rate plan charge |
This operation makes an HTTP GET request to the |
CRUD: Get rate plan charge |
This operation makes an HTTP GET request to the |
CRUD: Get usage |
This operation makes an HTTP GET request to the |
CRUD: Update product rate plan charge tier |
This operation makes an HTTP PUT request to the |
CRUD: Update rate plan charge |
This operation makes an HTTP PUT request to the |
Create custom object definition |
Post a custom object definition with the given type |
Create custom object records |
Create custom object records with the given type |
Create usage records |
Create usage records |
DELETE Data Query Job |
Cancels a [data query](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query) job, which prevents Zuora from performing the query |
Delete event trigger |
This operation makes an HTTP DELETE request to the |
Delete a workflow by ID |
Deletes a specific workflow by its ID |
Delete custom object definition |
This operation makes an HTTP DELETE request to the |
Delete custom object record |
This operation makes an HTTP DELETE request to the |
Delete schema of Usage custom field definition |
This operation makes an HTTP DELETE request to the |
Delete usage record |
This operation makes an HTTP DELETE request to the |
Download usage file template |
Download usage file template |
Download usage import failure file |
Download usage import failure file |
Download usage import file |
Download usage import file |
Export a workflow |
Export a Workflow in a JSON document |
Get Event Trigger |
This operation makes an HTTP GET request to the |
Get Event Triggers |
This operation makes an HTTP GET request to the |
Get Usage custom field definition |
Get Usage custom field definition |
Get a task by id |
Retrieves a specific workflow task by its ID |
Get a workflow by ID |
Retrieves information about a specific workflow by its ID |
Get all custom object definitions |
Retrieves information about a specific object definition |
Get custom object definition |
Retrieves information about a specific workflow by its ID |
Get custom object record |
Retrieves information about a custom record |
Get details of usage import |
Get details of usage import |
Get rated usage by account |
Get rated usage by account |
Get rated usage by charge |
Get rated usage by charge |
Get rated usage by subscription |
Get rated usage by subscription |
Get rating results by account |
Get rated usage by account |
Get rating results by charge |
Get rated usage by charge |
Get rating results by subscription |
Get rated usage by subscription |
Get status of usage import |
Get status of usage import |
Get tasks |
Retrieves a specific workflow task by its ID |
Get usage imports |
This operation makes an HTTP GET request to the |
Get usage record |
This operation makes an HTTP GET request to the |
Get work flows |
Retrieves a specific workflow task by its ID |
Import a workflow |
Imports a workflow by ID |
Import usage file |
Imports usage file |
List all settings |
Lists all settings |
Post data query job |
Submits a [data query](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query) to be performed by Zuora and creates a query job. You can use [Get data query job](#operation/GET_DataQueryJob) to track the status of the query job and obtain the URL of the query results. |
Post event trigger |
This operation makes an HTTP POST request to the |
Put event trigger |
This operation makes an HTTP GET request to the |
Query an accounting code |
This operation makes an HTTP POST request to the |
Query custom object records |
This operation makes an HTTP GET request to the |
Query usage records |
This operation makes an HTTP GET request to the |
Query usage records in stream |
This operation makes an HTTP GET request to the |
Re-open accounting period |
This operation makes an HTTP POST request to the |
Run a workflow |
Run a specified workflow. In the request body, you can include parameters that you want to pass to the workflow. For the parameters to be recognized and picked up by tasks in the workflow,you need to define the parameters first. |
Set schema of usage custom field definition |
Set schema of Usage custom field definition |
Submit multiple settings requests as a batch |
Submit multiple requests as a batch |
Update custom object definition |
This operation makes an HTTP PUT request to the |
Update custom object record |
This operation makes an HTTP PUT request to the |
Update individual fields in a custom object record |
Update individual fields in a record |
Update Or Delete Custom Object Records As a Batch |
This operation makes an HTTP PUT request to the |
Update Tasks In Batch |
This operation makes an HTTP PUT request to the |
Update Usage Record |
This operation makes an HTTP PUT request to the |
Removed Operations in Zuora Connector 5.0.0
Four operations were removed from the Zuora connector and are available in the new Anypoint Connector for AQuA (AQuA Connector).
Removed in Zuora 5.x | Available in Zuora AQuA 1.x as | ||
---|---|---|---|
Name |
Description |
Name |
Description |
Aqua_ Delete A Running Job |
Delete the current job, if it is not complete, else an error is thrown. |
Delete a Running Job |
No changes |
Aqua_ Get Job Results |
Retrieves an aggregate query using the Job ID. |
Get Job Results |
No changes |
Aqua_ Get Last Job Completed |
Returns the details of the last completed job. |
Get Last Job Completed |
No changes |
Aqua_ Post Query Or Export Deleted Data |
Post query. |
Post Query or Export Deleted Data |
No changes |
CRUD Operations
All of the CRUD operations were changed so that CRUD is prepended to operation names. A few examples are:
4.2.x | 5.0.0 |
---|---|
Create import crud operation |
CRUD: Create Import operation |
Delete bill run crud |
CRUD: Delete bill run |
Get account crud |
CRUD: Get account |
Update product crud |
CRUD: Update Product |
Changes to Operations Names
Some of the operations' names are updated:
4.2.x | 5.0.0 |
---|---|
Create revenue schedule for invoice item adjustment distribute by date range |
Create revenue schedule for invoice item adjustment (distribute by date range) |
Remove an event trigger |
DELETE Event Trigger |
Delete usage crud |
Delete usage record |
Changes in Fields and Values
Some fields and their corresponding values have changed:
-
The credit memo items operation and the taxation items created in the
write-off
operation are now applied to the corresponding invoice items and invoice taxation items, respectively. -
The values of the following fields are also changed to the taxation items of credit memo items operation:
-
taxRate
The value of this field is now set to0
. -
exemptAmount
The value of this field is now set to0
. -
taxRateType
The value of this field is now set tonull
.
-
Upgrade Prerequisites
Before you perform the upgrade, you must:
-
Create a backup of your files, data, and configuration in case you need to restore to the previous version.
-
Install Zuora AQuA Connector to replace the AQuA operations that were previously included in Zuora Connector 4.2.x.
Upgrade Steps
Follow these steps to perform the upgrade to Zuora Connector 5.0.0:
-
In Studio, create a Mule project.
-
In the Mule Palette view, click Search in Exchange.
-
In Add Modules to Project, type 'Zuora' in the search field.
-
In Available modules, select Zuora Connector, and then click Add.
-
Click Finish.
-
Verify that the
zuora-connector
dependency version is5.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:
-
In Anypoint Studio, verify that there are no errors in the Problems or Console views.
-
Check the project pom.xml and verify that there are no problems.
-
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 5.0.0
in the project’s pom.xml to the previous version.
You must update the project’s pom.xml in Anypoint Studio.