Zuora Connector 6.0 Reference - Mule 4
Anypoint Connector for Zuora (Zuora Connector) enables access to the Zuora platform. This connector exposes all of the operations provided by Zuora’s REST API.
Configurations
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Name |
String |
The name for this configuration. Connectors reference the configuration with this name. |
x |
|
Connection |
The connection types to provide to this configuration. |
x |
||
Response Timeout |
Number |
The timeout for request to the remote service. |
1 |
|
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
MINUTES |
|
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
AUTO |
|
Name |
String |
The identifier of this element used to reference it in other components |
x |
|
Expiration Policy |
Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime purges the instances when as appropriate. |
Connection Types
Basic Auth Connection Provider
Uses a username and password to connect.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Default Headers |
Array of Default Header |
|||
Query Parameters |
Array of Default Query Param |
|||
Connection Timeout |
Number |
Timeout for establishing connections to the remote service. |
30 |
|
Connection Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Connection Timeout. |
SECONDS |
|
Use Persistent Connections |
Boolean |
If false, each connection is closed after the first request is completed. |
true |
|
Max Connections |
Number |
Maximum number of outbound connections to keep open concurrently. |
-1 |
|
Connection Idle Timeout |
Number |
Timeout for how long a connection can remain idle before it is closed. |
30 |
|
Connection Idle Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Connection Idle Timeout. |
SECONDS |
|
Proxy Config |
Reusable configuration element for outbound connections through a proxy. |
|||
Stream Response |
Boolean |
Whether or not to stream received responses. |
false |
|
Response Buffer Size |
Number |
The space in bytes for the buffer where the HTTP response will be stored. |
-1 |
|
Username |
String |
Username to authenticate the requests |
||
Password |
String |
Password to authenticate the requests |
||
Base Uri |
String |
Parameter base URI, each instance or tenant gets its own base URI. |
|
|
TLS Configuration |
||||
Reconnection |
When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy. |
Oauth2 Connection Provider
Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to Configuring OAuth 2.0 for Connectors or Configuring OAuth 2.0 for Connectors on CloudHub.
Uses the Client Credentials grant type to connect using the client ID, client secret, and token URL.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Default Headers |
Array of Default Header |
|||
Query Parameters |
Array of Default Query Param |
|||
Connection Timeout |
Number |
The timeout for establishing connections to the remote service. |
30 |
|
Connection Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Connection Timeout. |
SECONDS |
|
Use Persistent Connections |
Boolean |
If false, each connection is closed after the first request is completed. |
true |
|
Max Connections |
Number |
Maximum number of outbound connections to keep open concurrently. |
-1 |
|
Connection Idle Timeout |
Number |
Timeout for how long a connection can remain idle before it is closed. |
30 |
|
Connection Idle Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Connection Idle Timeout. |
SECONDS |
|
Proxy Config |
Reusable configuration element for outbound connections through a proxy. |
|||
Stream Response |
Boolean |
Whether or not to stream received responses. |
false |
|
Response Buffer Size |
Number |
The space in bytes for the buffer where the HTTP response will be stored. |
-1 |
|
Base Uri |
String |
Parameter base URI. Each instance or tenant gets its own base URI. |
|
|
TLS Configuration |
||||
Reconnection |
When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy. |
|||
Client Id |
String |
OAuth client ID that is registered with the service provider. |
x |
|
Client Secret |
String |
OAuth client secret that is registered with the service provider. |
x |
|
Token Url |
String |
Service provider’s token endpoint URL. |
`https://rest.apisandbox.zuora.com/oauth/token` |
|
Scopes |
String |
OAuth scopes to request during the OAuth dance. If the scopes are not provided, the scopes in the annotation are used. |
||
Object Store |
String |
A reference to the object store to use to store each resource owner ID’s data. If the object store is not specified, Mule automatically provisions the default object store. |
Supported Operations
-
Create Revenue Schedule for Credit Memo Item (manual distribution)
-
Create Revenue Schedule for Credit Memo Item (distribute by date range)
-
Create Revenue Schedule for Debit Memo Item (manual distribution)
-
Create revenue schedule for debit memo item (distribute by date range)
-
Create revenue schedule for Invoice Item Adjustment (manual distribution)
-
Create revenue schedule for Invoice Item Adjustment (distribute by
-
Create revenue schedule for Invoice Item (manual distribution)
-
Create Revenue Schedule for Invoice Item (distribute by date range)
-
Get all revenue schedules of product charge by charge ID and billing
-
Update custom fields on revenue items by revenue event number
-
Update custom fields on revenue items by revenue schedule number
-
Update subscription custom fields of a specified subscription version
Create an Event Trigger
<mule-zuora-connector:create-events-event-triggers>
You can define an event trigger on any of the following objects:
-
Account
-
AccountingCode
-
AccountingPeriod
-
Amendment
-
BillingRun
-
Contact
-
CreditBalanceAdjustment
-
CreditMemo
-
CreditMemoApplication
-
CreditMemoApplicationItem
-
CreditMemoItem
-
DebitMemo
-
DebitMemoItem
-
Feature
-
Invoice
-
InvoiceAdjustment
-
InvoiceItem
-
InvoiceItemAdjustment
-
JournalEntry
-
JournalEntryItem
-
Order
-
OrderAction
-
Payment
-
PaymentApplication
-
PaymentMethod
-
PaymentPart
-
Product
-
ProductFeature
-
ProductRatePlan
-
ProductRatePlanCharge
-
RatePlan
-
RatePlanCharge
-
Refund
-
RefundApplication
-
RevenueEvent
-
RevenueEventItem
-
RevenueSchedule
-
RevenueScheduleItem
-
Subscription
-
SubscriptionProductFeature
-
TaxationItem
-
Usage
The baseObject field specifies the object on which to define a trigger. The condition field is a JEXL expression that specifies when to trigger events. The expression can contain fields from the object that the trigger is defined on.
The condition cannot contain fields from data source objects that are joined to the object that the trigger is defined on. For example, the following condition causes an event to be triggered whenever an invoice is posted with an amount greater than 1000:
changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 1000
Where:
-
changeTypeis a keyword that specifies the type of change that occurred to the Invoice object. For all objects, the supported values ofchangeTypeareINSERT,UPDATE, andDELETE. -
Invoice.Statusis the value of the Invoice object’sStatusfield after the change occurred. -
Invoice.Status_oldis the value of the Invoice object’sStatusfield before the change occurred. In the above example, the value ofbaseObjectwould beInvoice.
The number of the event triggers that you can create depends on the edition of Zuora Central Platform you are using. This operation makes an HTTP POST request to the/events/event-triggersendpoint. === Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Authorization |
String |
|
x |
|
Zuora Entity Ids |
String |
An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls to assist with troubleshooting. The value of this field must use the US-ASCII character set and must not include any of the following characters:
|
||
Content |
Binary |
The content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to use streaming when the request is sent. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create an Email Template
<mule-zuora-connector:create-notifications-email-templates>
This operation creates an email template and makes an HTTP POST request to the /notifications/email-templates endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Authorization |
String |
|
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters:
|
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
The content to use. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create a notification definition
<mule-zuora-connector:create-notifications-notification-definitions>
Creates a notification definition. If a filter rule is specified, it will be evaluated to see if the notification definition is qualified to handle the incoming events during runtime. If the notification is qualified, it will send the email and invoke the callout if it has an email template or a callout. This operation makes an HTTP POST request to the /notifications/notification-definitions endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Authorization |
String |
|
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Generate an OAuth Token
<mule-zuora-connector:create-oauth-token>
Generates a bearer token that enables an OAuth client to authenticate with the Zuora REST API. The OAuth client must be created using the Zuora UI. See Authentication for more information.
When using this operation, do not set any authentication headers such as Authorization, apiAccessKeyId, or apiSecretAccessKey.
|
Do not use this operation to generate a large number of bearer tokens in a short period of time; use each token until it expires. If you receive a 429 Too Many Requests response when using this operation, reduce the frequency of requests. This endpoint is rate limited according to IP address. The rate limit is 100 requests per minute. This operation makes an HTTP POST request to the /oauth/token endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls to assist with troubleshooting. The value of this field must use the US-ASCII character set and must not include any of the following characters:
|
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Update or Delete Custom Object Records as a Batch
<mule-zuora-connector:create-objects-batch-default-by-object>
This operation enables you to make a batch update or delete of custom object records.
This operation makes an HTTP POST request to the /objects/batch/default/{object} endpoint.
Limitations
This call has the following limitations:
-
The maximum number of records that you can update by one call is 1,000.
-
The maximum number of records that you can delete by one call is 1,000.
-
The storage of empty strings in records is not supported.
-
Null values must be formatted as the following example:
{ "records": [ { "fieldName__c": null } ] }
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
object |
String |
Specifies the custom object''s API name as object. It is case-sensitive. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Authorization |
String |
|
x |
|
Zuora Version |
String |
API version that determines the response schema. The default version is used if this parameter is not included. Specify |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create Custom Object Definition
<mule-zuora-connector:create-objects-definitions-default>
This operation enables you to Post a custom object definition with the given type. The label field is the UI label of the custom object. The object field contains the API Name of the custom object.
This operation makes an HTTP POST request to the /objects/definitions/default endpoint.
Limitations
The custom object definition has the following limitations:
-
The maximum number of characters for the Custom Object API Name (
object) is 64. -
The maximum number of characters for the Custom Object Label (
label) is 64. -
The maximum number of characters for the Custom Object Description 250.
-
The maximum number of custom fields in an custom object is 50.
-
The maximum number of characters for the custom field API name is 64.
-
The maximum number of characters for the custom field label (
label) is 64. -
The maximum number of characters for the custom field Description is 250.
-
The maximum number of picklist options is 250.
-
The default maximum number of characters for the Text field is 512.
You can configure the maximum length, up to 4,096, characters when creating or updating the custom object definition using an API.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Authorization |
String |
|
x |
|
Zuora Version |
String |
API version that determines the response schema. The default version is used if this parameter is not included. Specify |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Update Custom Object Definition
<mule-zuora-connector:create-objects-migrations>
This operation updates custom object definitions by posting migration resources to initiate the migration of definitions.
This operation makes an HTTP POST request to the /objects/migrations endpoint.
Limitations
Updating custom field definition has the following limitations:
-
You can only have one action per update request.
-
You cannot delete field definitions from custom object definitions that contain records.
-
You cannot add new required fields.
-
You cannot change optional fields to required.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Authorization |
String |
|
x |
|
Zuora Version |
String |
API version that determines the response schema. The default version is used if this parameter is not included. Specify |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create Custom Object Records
<mule-zuora-connector:create-objects-records-default-by-object>
This operation creates custom object records with the given type. When creating records of a custom object type, the 200 response provides the following information:
-
A list of records that have been successfully processed and stored
-
A list of records that have not been successfully processed and therefore not stored.
This operation makes an HTTP POST request to the /objects/records/default/{object} endpoint.
Limitations
This call has the following limitations:
-
The maximum number of records that you can create by one call is 1,000.
-
The storage of empty strings in records is not supported.
-
Null values must be formatted as the following example:
{ "records": [ { "fieldName__c": null } ] }
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
object |
String |
Specifies the custom object''s API name as object. It is case-sensitive. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Authorization |
String |
|
x |
|
Zuora Version |
String |
API version that determines the response schema. The default version is used if this parameter is not included. Specify |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Submit Data Query
<mule-zuora-connector:create-query-jobs>
This operation submits a data query to be performed by Zuora and creates a query job.
You can use Get data query job to track the status of the query job and obtain the URL of the query results.
This operation makes an HTTP POST request to the /query/jobs endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Authorization |
String |
|
x |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Submit Multiple Settings Requests as a Batch
<mule-zuora-connector:create-settings-batch-requests>
This operation submits multiple settings requests as a batch.
This operation makes an HTTP POST request to the /settings/batch-requests endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Authorization |
String |
|
x |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create Accounting Code
<mule-zuora-connector:create-v1-accounting-codes>
This reference describes how to create a new accounting code through the REST API. The accounting code is active as soon as it is created.
This operation makes an HTTP POST request to the /v1/accounting-codes endpoint.
Before You Begin
If you have Zuora Finance enabled on your tenant, you must have the Configure Accounting Codes permission.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create Accounting Period
<mule-zuora-connector:create-v1-accounting-periods>
Creates an accounting period.
This operation makes an HTTP POST request to the /v1/accounting-periods endpoint.
Before You Begin
-
You must have Zuora Finance enabled on your tenant.
-
You must have the Create Accounting Period user permission.
Limitations
-
When creating the first accounting period on your tenant, the start date must be equal to or earlier than the date of the earliest transaction on the tenant.
-
Start and end dates of accounting periods must be contiguous. For example, if one accounting period ends on January 31, the next period must start on February 1.
-
If you have the Revenue Recognition Package and have enabled the "Monthly recognition over time" revenue recognition model, the accounting period start date and end date must be on the first day and last day of the month, respectively. Note that the start and end dates do not necessarily have to be in the same month.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create Account
<mule-zuora-connector:create-v1-accounts>
This operation creates a customer account with a credit card payment method, a bill-to contact, and an optional sold-to contact. Request and response field descriptions and sample code are provided.
Use this operation to optionally create a subscription, invoice for that subscription, and collect payment through the default payment method. The transaction is atomic, which means that if any part fails for any reason, the entire transaction is rolled back.
This operation is CORS-enabled, so you can use client-side Javascript to invoke the call.
This operation makes an HTTP POST request to the /v1/accounts endpoint.
Notes
-
The account is created in active status.
-
If the
autoPayfield is set totruein the request, you must provide either thecreditCardfield or thehpmCreditCardPaymentMethodIdfield, but not both. The one provided becomes the default payment method for this account. If the credit card information is declined or cannot be verified, no account is created. -
Customer accounts created with this call are automatically be set to Auto Pay.
-
If either the
workEmailorpersonalEmailfield is specified, then the account’s email delivery preference is automatically set totrue, in which case, emails go to theworkEmailorpersonalEmailaddress, if they exist. If neither field is specified, the email delivery preference is automatically set tofalse.
Defaults for customerAcceptanceDate and serviceActivationDate Default values for customerAcceptanceDate and serviceActivationDate are set as follows:
serviceActivationDate(SA) specified |
serviceActivationDate (SA) NOT specified |
|
customerAcceptanceDate (CA) specified |
SA uses value in the request call; CA uses value in the request call |
CA uses value in the request call;SA uses CE as default |
customerAcceptanceDate (CA) NOT specified |
SA uses value in the request call; CA uses SA as default |
SA and CA use CE as default |
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora 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 |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create Job to Hard Delete Billing Document Files
<mule-zuora-connector:create-v1-accounts-billing-documents-files-deletion-jobs>
This operation creates an asynchronous job to permanently delete all billing document PDF files for specific accounts. After the deletion job is completed, all billing document PDF files are permanently deleted.
To retrieve the status of a deletion job, call [Get job of hard deleting billing document files](https://www.zuora.com/developer/api-reference/#operation/GET_BillingDocumentFilesDeletionJob).
| This operation can be used only if you have the Billing user permission "Hard Delete Billing Document Files" enabled. |
This operation makes an HTTP POST request to the /v1/accounts/billing-documents/files/deletion-jobs endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Generate Billing Documents by Account
<mule-zuora-connector:create-v1-accounts-billing-documents-generate-by-id>
This operation generates draft or posted billing documents for a specified account.
You can also generate billing documents for specified subscriptions of a specified account. The billing documents contain invoices and credit memos.
To generate credit memos, you must have the Invoice Settlement feature enabled.
You cannot generate billing documents for cancelled or suspended subscriptions.
This operation makes an HTTP POST request to the /v1/accounts/{id}/billing-documents/generate endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The ID of the customer account that billing documents are generated for. For example, 8a8082e65b27f6c3015ba3e326b26419. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Amend
<mule-zuora-connector:create-v1-action-amend>
This operation modifies a subscription by creating Amendment objects. However, to modify a subscription, Zuora recommends that you use [Update subscription](https://www.zuora.com/developer/api-reference/#operation/PUT_Subscription) instead of this operation.
You cannot use this operation to update multiple subscriptions.
You can use this operation to create up to 10 Amendment objects.
You must specify the following fields for each Amendment object:
-
ContractEffectiveDate -
Name -
SubscriptionId
The value ofSubscriptionIdmust be the same for each Amendment object. -
Type
When you call this operation, Zuora modifies the subscription in the order that you specify Amendment objects in the request body. If Zuora is unable to create an Amendment object when you call this operation, the entire call fails.
This operation makes an HTTP POST request to the /v1/action/amend endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
X Zuora WSDL Version |
String |
Zuora WSDL version number. |
79 |
|
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create
<mule-zuora-connector:create-v1-action-create>
Use the create call to create one or more objects of a specific type.
You can specify different types in different create calls, but each create call must apply to only one type of object.
Limitations
This call has the following limitations:
-
A maximum of 50 objects are supported in a single call.
-
The Invoice Settlement feature is not supported. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement.
-
The default WSDL version for Actions is 79. To create objects according to a different WSDL version, set the
X-Zuora-WSDL-Versionheader.
To find out in which WSDL version a particular object or field was introduced, see [Zuora SOAP API Version History](https://knowledgecenter.zuora.com/DC_Developers/G_SOAP_API/Zuora_SOAP_API_Version_History).
How to Use this Call
You can call create on an array of one or more zObjects. It returns an array of SaveResults, indicating the success or failure of creating each object. The following information applies to this call:
-
Cannot pass in null zObjects
-
Can pass in a maximum of 50 zObjects at a time
-
All objects must be of the same type
Using Create and Subscribe Calls
Both the create and subscribe calls will create a new account. However, there are differences between the calls. Use the create call to create an account independent of a subscription. Use the subscribe call to create the account with the subscription and the initial payment information.
This operation makes an HTTP POST request to the /v1/action/create endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
X Zuora WSDL Version |
String |
Zuora WSDL version number. |
79 |
|
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Delete
<mule-zuora-connector:create-v1-action-delete>
Deletes one or more objects of the same type. This operation makes an HTTP POST request to the /v1/action/delete endpoint.
You can specify different types in different delete calls, but each delete call must apply only to one type of object.
The following information applies to this call:
-
You need to first determine the IDs for the objects to delete.
-
You cannot pass in any null IDs.
-
All objects in a specific delete call must be of the same type.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
X Zuora WSDL Version |
String |
Zuora WSDL version number. |
79 |
|
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Execute
<mule-zuora-connector:create-v1-action-execute>
Use the Execute call to execute a process to split an invoice into multiple invoices. The original invoice must be in draft status. The resulting invoices are called split invoices.
| This feature is in Limited Availability. If you want access to the feature, submit a request to Zuora Global Support. |
To split a draft invoice into multiple split invoices:
-
Use the create call to create a separate InvoiceSplitItem object for each split invoice that you want to create from the original draft invoice.
-
Use the create call to create a single InvoiceSplit object to collect all of the InvoiceSplitItem objects.
-
Use the execute call to split the draft invoice into multiple split invoices.
You need to create InvoiceSplitItem objects and an InvoiceSplit object before you can use the execute call.
Supported objects:
-
InvoiceSplit
-
Asynchronous process
This operation makes an HTTP POST request to the /v1/action/execute endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
X Zuora WSDL Version |
String |
Zuora WSDL version number. |
79 |
|
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Generate
<mule-zuora-connector:create-v1-action-generate>
This operation generates an on-demand invoice for a specific customer. This is similar to creating an ad-hoc bill run for a specific customer account in the Zuora UI.
Supported objects:
-
Invoice
-
Asynchronous process: yes
The ID of the generated invoice is returned in the response. If multiple invoices are generated, only the ID of the first invoice generated is returned. This occurs when an account has multiple subscriptions with the [invoice subscription separately](https://knowledgecenter.zuora.com/BC_Subscription_Management/Subscriptions/B_Creating_Subscriptions/Invoicing_Subscriptions_Separately) option enabled.
This operation makes an HTTP POST request to the /v1/action/generate endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
X Zuora WSDL Version |
String |
Zuora WSDL version number. |
79 |
|
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Query
<mule-zuora-connector:create-v1-action-query>
The query call sends a query expression by specifying the object to query, the fields to retrieve from that object, and any filters to determine whether a given object should be queried.
You can use Zuora Object Query Language (ZOQL) to construct those queries, passing them through the queryString. Once the call is made, the API executes the query against the specified object and returns a query response object to your application. Your application can then iterate through rows in the query response to retrieve information.
This operation makes an HTTP POST request to the /v1/action/query endpoint.
Limitations
This call has the following limitations:
-
All ZOQL keywords must be in lower case.
-
The number of records returned is limited to 2000 records
-
The Invoice Settlement feature is not supported. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement.
-
The default WSDL version for Actions is 79. To query objects or fields according to a different WSDL version, set the
X-Zuora-WSDL-Versionheader. To find out in which WSDL version a particular object or field was introduced, see xhttps://knowledgecenter.zuora.com/DC_Developers/G_SOAP_API/Zuora_SOAP_API_Version_History[Zuora Object Query Language].
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
X Zuora WSDL Version |
String |
Zuora WSDL version number. |
79 |
|
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Query More
<mule-zuora-connector:create-v1-action-query-more>
Use queryMore to request additional results from a previous query call. If your initial query call returns more than 2000 results, you can use queryMore to query for the additional results. Any queryLocator results greater than 2,000 are stored by Zuora for only 5 days before the results are deleted.
If the initial query call returns more than 2000 results, you can use the queryLocator returned from the query to request the next set of results.
Note: Zuora expires queryMore cursors after 15 minutes of activity. To use queryMore, you must first construct a query call. By default, the query call returns up to 2000 results. If there are more than 2000 results, the query returns a boolean done, which will be marked as false, and a queryLocator, which is a marker you will pass to queryMore to get the next set of results.
This operation makes an HTTP POST request to the /v1/action/queryMore endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
X Zuora WSDL Version |
String |
Zuora WSDL version number. |
79 |
|
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Subscribe
<mule-zuora-connector:create-v1-action-subscribe>
This call performs many actions. Use the subscribe call to bundle information required to create at least one new subscription. The call takes in an array of SubscribeRequests. Because it takes an array, you can submit a batch of subscription requests at once.
You can create up to 50 different subscriptions in a single subscribe call.
This is a combined call that you can use to perform all of the following tasks in a single call:
-
Create accounts
-
Create contacts
-
Create payment methods, including external payment options
-
Create an invoice for the subscription
-
Apply the first payment to a subscription === Object Limits
50 objects are supported in a single call.
Effective Date
If the effective date is in the future, the invoices will not be generated, and there will be no invoice number.
Subscription Name and Number
The subscription name is a unique identifier for the subscription. If you do not specify a value for the name, Zuora creates one automatically. The automatically generated value is known as the subscription number, such as A-S00000080.
You cannot change the subscription name or number after creating the subscription.
-
Subscription name: The name that you set for the subscription.
-
Subscription number: The value generated by Zuora automatically if you do not specify a subscription name. Both the subscription name and number must be unique. If they are not, an error will occur.
Subscription ID
The subscription ID is a 32-digit ID in the format 4028xxxx. This is also the unique identifier for a subscription. This value is automatically generated by the system and cannot be edited or updated, but it can be queried. One subscription can have only one subscription name or number, but it can have multiple IDs: Each version of a subscription has a different ID.
The Subscription object contains the fields OriginalId and PreviousSubscriptionId. OriginalId is the ID for the first version of a subscription. PreviousSubscriptionId is the ID of the version created immediately prior to the current version.
Invoice Subscriptions Separately
If you have enabled the invoice subscriptions separately feature, a subscribe call will generate an invoice for each subscription for every subscription where the field IsInvoiceSeparate is set to true.
If the invoice subscriptions separately feature is disabled, a subscribe call will generate a single invoice for all subscriptions. See [Invoicing Subscriptions Separately](https://knowledgecenter.zuora.com/BC_Subscription_Management/Subscriptions/B_Creating_Subscriptions/Invoicing_Subscriptions_Separately) for more information.
Subscriptions and Draft Invoices
If a draft invoice that includes charges exists in a customer account, using the subscribe call to create a new subscription and generate an invoice will cause the new subscription to be added to the existing draft invoice. Zuora will then post the invoice.
When to Use Subscribe and Create Calls
You can use either the subscribe call or the create call to create the objects associated with a subscription (accounts, contacts, and so on). There are differences between these calls, however, and some situations are better for one or the other.
Use the Subscribe Call
The subscribe call bundles up all the information you need for a subscription. Use the subscribe call to create new subscriptions when you have all the information you need. Subscribe calls cannot update BillTo, SoldTo, and Account objects.
Payment information objects cannot be updated if there is an existing account ID in the call. These objects are not supported in a subscribe call.
Use the Create Call
The create call is more useful when you want to develop in stages. For example, if you want to first create an account, then a contact, and so on. If you do not have all information available, use the create call. To create a subscription, you must activate the account from Draft status to Active by calling the subscribe call.
This operation makes an HTTP POST request to the /v1/action/subscribe endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
X Zuora WSDL Version |
String |
Zuora WSDL version number. |
79 |
|
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Update
<mule-zuora-connector:create-v1-action-update>
Updates the information in one or more objects of the same type.
You can specify different types of objects in different update calls, but each specific update call must apply to only one type of object.
You can update an array of one or more zObjects. It returns an array of SaveResults, indicating the success or failure of updating each object.
The following information applies to this call:
-
You cannot pass in null zObjects.
-
You can pass in a maximum of 50 zObjects at a time.
-
All objects must be of the same type.
-
For each field in each object, you must determine that object’s ID. Then populate the fields that you want update with the new information.
-
Zuora ignores unrecognized fields in update calls.
For example, if an optional field is spelled incorrectly or a field that does not exist is specified, Zuora ignores the field and continues to process the call. No error message is returned for unrecognized fields.
Limitations
This call has the following limitations:
-
A maximum of 50 objects are supported in a single call.
-
The Invoice Settlement feature is not supported. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement.
-
The default WSDL version for Actions is 79. To update objects or fields according to a different WSDL version, set the
X-Zuora-WSDL-Versionheader. To find out in which WSDL version a particular object or field was introduced, see [Zuora SOAP API Version History](https://knowledgecenter.zuora.com/DC_Developers/G_SOAP_API/Zuora_SOAP_API_Version_History).
This operation makes an HTTP POST request to the /v1/action/update endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
X Zuora WSDL Version |
String |
Zuora WSDL version number. |
79 |
|
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create Order Asynchronously
<mule-zuora-connector:create-v1-async-orders>
| This operation is only available if you have the Orders feature enabled. This operation is in Limited Availability. |
If a normal "Create order" operation call is likely to time out, use this operation instead to create an order asynchronously. When an order is created asynchronously, a job creates the order in the back end and the job ID will be returned for tracking the job status and result.
This operation makes an HTTP POST request to the /v1/async/orders endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Return Ids |
Boolean |
Specify whether to return IDs for the [Get job status and response](https://www.zuora.com/developer/api-reference/#operation/GET_JobStatusAndResponse) operation. If you set this query parameter to |
false |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora version |
String |
The minor version of the Zuora REST API. You need to set this parameter if you want to use the following fields: * subscriptions * subscriptionNumbers * subscriptionIds (when the |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Preview Order Asynchronously
<mule-zuora-connector:create-v1-async-orders-preview>
| This operation is only available if you have the Zuora Orders feature enabled. |
This operation is Limited Availability.
If a normal "Preview order" operation call is likely to time out, use this operation instead to preview an order asynchronously. When you use this operation, a job previews the order in the back end and the job ID will be returned for tracking the job status and result.
This operation makes an HTTP POST request to the /v1/async/orders/preview endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Add Attachments
<mule-zuora-connector:create-v1-attachments>
Use the Add Attachment REST request with a multipart/form-data to attach a document file to an Account, a Subscription, or an Invoice. This operation makes an HTTP POST request to the /v1/attachments endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
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 Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
File Content |
String |
The content of the 'File' part. |
#[payload] |
|
File Filename |
String |
The filename of the 'File' part (just the name, do not include path). |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Email Billing Documents Generated From Bill Run
<mule-zuora-connector:create-v1-bill-runs-emails-by-bill-run-id>
Manually emails all the billing documents that are generated from a specified bill run to your customers. Bill runs can generate invoices and credit memos based on your invoice and credit memo generation rule. Credit memos are only available if you have the Invoice Settlement feature enabled. Using this API operation, the billing documents are sent to the email addresses specified in the To Email field of the email templates. The email template used for each billing document is set in the Delivery Options panel of the Edit notification dialog from the Zuora UI. See Edit Email Templates for more information about how to edit the To Email field in the email template.
Notes
-
Even though no field is required in the Request body, you still need to specify
{}in the request. Otherwise, an error will be returned. -
You can only email posted billing documents.
-
You must activate the following notifications before emailing invoices and credit memos: + Manual Email For Invoice | Manual Email For Invoice - Email Credit Memo | Manually email Credit Memo
-
To include the invoice PDF in the email, select the Include Invoice PDF check box in the Edit notification dialog from the Zuora UI. To include the credit memo PDF in the email, select the Include Credit Memo PDF check box in the Edit notification dialog from the Zuora UI. See [Create and Edit Notifications](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/C_Create_Notifications#section_2) for more information.
-
Zuora sends the email messages based on the email template you set.
-
You can set the email template to use in the Delivery Options panel of the Edit notification dialog from the Zuora UI. By default, the following templates are used for billing documents:
-
Invoices: Invoice Posted Default Email Template
-
Credit memos: Manual Email for Credit Memo Default Template
See [Create and Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information.
-
This operation makes an HTTP POST request to the /v1/bill-runs/{billRunId}/emails endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Bill Run Id |
String |
The ID of the bill run. For example, 2c92c8f95d0c886e015d11287a8f0f8b. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create Billing Preview Run
<mule-zuora-connector:create-v1-billing-preview-runs>
| This feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support. Creates billing preview runs for multiple customer accounts. |
You can run up to 10 billing previews in batches concurrently. A single batch of customer accounts can only have one billing preview run at a time. So you can have up to 10 batches running at the same time. If you create a billing preview run for all customer batches, you cannot create another billing preview run until this preview run is completed.
This operation makes an HTTP POST request to the /v1/billing-preview-runs endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Perform Mass Action
<mule-zuora-connector:create-v1-bulk>
This reference describes how to perform a mass action through the REST API. Using this API method, you send a multipart/form-data request containing a .csv file with data about the mass action you want to perform. Zuora returns a key and then asynchronously processes the mass action.
You can use the key to get details about the result of the mass action. This operation makes an HTTP POST request to the /v1/bulk endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
File Content |
String |
The content of the 'File' part. |
#[payload] |
|
File Filename |
String |
The filename of the 'File' part (just the name, do not include path). |
x |
|
Params Content |
String |
The content of the 'parameters' part. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Multi-entity: Share a Product With an Entity
<mule-zuora-connector:create-v1-catalog-products-share-by-product-id>
| The Multi-entity feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support. Shares a product with a target entity. Zuora synchronizes the shared products to the target entity after sharing. For more information about product sharing, see [Products Sharing Across Entities](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity/C_Business_Objects_Sharing_Across_Entities/B_Products_Sharing_Across_Entities). |
You must finish all the prerequisites before sharing products with other entities.
Only source entity administrators have permission to share products with other entities.
You must make the call as a source entity administrator. - Currently, you can only share a product with one entity at a time. An error occurs if you try to share a product to more than one entity.
This operation makes an HTTP POST request to the /v1/catalog/products/{product-id}/share endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Product id |
String |
The unique ID of the product you want to share. For example, 8a808255575bdae4015774e9602e16fe. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Establish Connection to Zuora REST API Service
<mule-zuora-connector:create-v1-connections>
Establishes a connection to the Zuora REST API service based on a valid user credentials. Note:This is a legacy REST API. Zuora recommends you to use [OAuth](https://www.zuora.com/developer/api-reference/#section/Authentication/OAuth-v2.0) for authentication instead. This call authenticates the user and returns an API session cookie that’s used to authorize subsequent calls to the REST API. The credentials must belong to a user account that has permission to access the API service. As noted elsewhere, it’s strongly recommended that an account used for Zuora API activity is never used to log into the Zuora UI. Once an account is used to log into the UI, it may be subject to periodic forced password changes, which may eventually lead to authentication failures when using the API.
This operation makes an HTTP POST request to the /v1/connections endpoint
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 |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Api Secret Access Key |
String |
Account password |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content Type |
String |
Must be set to "application/json" |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create Credit Memo from Charge
<mule-zuora-connector:create-v1-creditmemos>
| The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support. Creates an ad-hoc credit memo from a product rate plan charge. Zuora supports the creation of credit memos from any type of product rate plan charge. The charges can also have any amount and any charge model, except for discout charge models. |
You can create a credit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.
This operation makes an HTTP POST request to the /v1/creditmemos endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora version |
String |
The minor version of the Zuora REST API. See [Minor Version](https://www.zuora.com/developer/api-reference/#section/API-Versions/Minor-Version) for information about REST API version control. This header affects the availability of the following request fields: * |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Email Credit Memo
<mule-zuora-connector:create-v1-creditmemos-emails-by-credit-memo-id>
The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).
This operation sends a posted credit memo to the specified email addresses manually.
Notes
-
You must activate the Email Credit Memo | Manually email Credit Memo notification before emailing credit memos. To include the credit memo PDF in the email, select the Include Credit Memo PDF check box in the Edit notification dialog from the Zuora UI. See [Create and Edit Notifications](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/C_Create_Notifications#section_2) for more information.
-
Zuora sends the email messages based on the email template you set.
-
You can set the email template to use in the Delivery Options panel of the Edit notification dialog from the Zuora UI. By default, the Manual Email for Credit Memo Default Template template is used. See [Create and Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information.
-
The credit memos are sent only to the work email addresses or personal email addresses of the Bill To contact if the following conditions are all met:
-
The
useEmailTemplateSettingfield is set tofalse. -
The email addresses are not specified in the
emailAddressesfield.
-
This operation makes an HTTP POST request to the /v1/creditmemos/{creditMemoId}/emails endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Credit Memo Id |
String |
The ID of a posted credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Upload File for Credit Memo
<mule-zuora-connector:create-v1-creditmemos-files-by-credit-memo-id>
| The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support. |
This operation uploads an externally generated PDF file for a credit memo that is in Draft or Posted status. This operation has the following restrictions:
-
Only the PDF file format is supported.
-
The maximum size of the PDF file to upload is 4 MB.
-
A maximum of 50 PDF files can be uploaded for one credit memo.
This operation makes an HTTP POST request to the /v1/creditmemos/{creditMemoId}/files endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Credit Memo Id |
String |
The ID of the credit memo that you want to upload a PDF file for. For example, 402890555a7e9791015a879f064a0054. |
x |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
File Content |
String |
The content of the 'File' part. |
#[payload] |
|
File Filename |
String |
The filename of the 'File' part (just the name, do not include path). |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create Credit Memo PDF
<mule-zuora-connector:create-v1-creditmemos-pdfs-by-credit-memo-id>
Note: The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support.
This operation creates a PDF file for a specified credit memo. To access the generated PDF file, you can download it by clicking View PDF on the detailed credit memo page through the Zuora UI. This REST API operation can be used only if you have the Billing user permission "Regenerate PDF" enabled.
This operation makes an HTTP POST request to the /v1/creditmemos/{creditMemoId}/pdfs endpoint.
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 the credit memo that you want to create a PDF file for. For example, 8a8082e65b27f6c3015ba45ff82c7172. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Refund Credit Memo
<mule-zuora-connector:create-v1-creditmemos-refunds-by-creditmemo-id>
| The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support. |
This operation refunds a full or partial posted credit memo to your customers. Only the amount of unapplied part could be refunded.
You can refund a credit memo only if you have the user permission. See Billing Roles for more information.
This operation makes an HTTP POST request to the /v1/creditmemos/{creditmemoId}/refunds endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Creditmemo Id |
String |
The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create Taxation Items for Credit Memo
<mule-zuora-connector:create-v1-creditmemos-taxationitems-by-credit-memo-id>
Note: This feature is only available if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support.
This operation creates taxation items for a credit memo and makes an HTTP POST request to the /v1/creditmemos/{creditMemoId}/taxationitems endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Credit Memo Id |
String |
The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create Debit Memo from Charge
<mule-zuora-connector:create-v1-debitmemos>
| The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support. |
This operation creates an ad-hoc debit memo from a product rate plan charge. Zuora supports the creation of debit memos from any type of product rate plan charge. The charges can also have any amount and any charge model, except for discout charge models.
You can create a debit memo only if you have the user permission. See Billing Roles for more information.
This operation makes an HTTP POST request to the /v1/debitmemos endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora version |
String |
The minor version of the Zuora REST API. See Minor Version for information about REST API version control. This header affects the availability of the following request fields:
|
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Email Debit Memo
<mule-zuora-connector:create-v1-debitmemos-emails-by-debit-memo-id>
Note: The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support. Sends a posted debit memo to the specified email addresses manually.
Notes
-
You must activate the Email Debit Memo | Manually email Debit Memo notification before emailing debit memos. To include the debit memo PDF in the email, select the Include Debit Memo PDF check box in the Edit notification dialog from the Zuora UI. See [Create and Edit Notifications](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/C_Create_Notifications#section_2) for more information.
-
Zuora sends the email messages based on the email template you set.
You can set the email template to use in the Delivery Options panel of the Edit notification dialog from the Zuora UI. By default, the Manual Email for Debit Memo Default Template template is used. See [Create and Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information. -
The debit memos are sent only to the work email addresses or personal email addresses of the Bill To contact if the following conditions are all met:
-
The
useEmailTemplateSettingfield is set tofalse. -
The email addresses are not specified in the
emailAddressesfield.
-
This operation makes an HTTP POST request to the /v1/debitmemos/{debitMemoId}/emails endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Debit Memo Id |
String |
The ID of a posted debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Upload File for Debit Memo
<mule-zuora-connector:create-v1-debitmemos-files-by-debit-memo-id>
The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to the feature, submit a request to Zuora Global Support at http://support.zuora.com/.
This operation uploads an externally generated PDF file for a debit memo that is in Draft or Posted status. This operation has the following restrictions:
-
Only the PDF file format is supported.
-
The maximum size of the PDF file to upload is 4 MB.
-
A maximum of 50 PDF files can be uploaded for one debit memo.
This operation makes an HTTP POST request to the /v1/debitmemos/{debitMemoId}/files endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Debit Memo Id |
String |
The ID of the debit memo that you want to upload a PDF file for. For example, 402890555a87d7f5015a8919e4fe002e. |
x |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
File Content |
String |
The content of the 'File' part. |
#[payload] |
|
File Filename |
String |
The filename of the 'File' part (just the name, do not include path). |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create Debit Memo PDF
<mule-zuora-connector:create-v1-debitmemos-pdfs-by-debit-memo-id>
| The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to the feature, submit a request at Zuora Global Support. |
This operation creates a PDF file for a specified debit memo. To access the generated PDF file, you can download it by clicking View PDF on the detailed debit memo page using the Zuora UI.
This REST API operation can be used only if you have the Billing user permission "Regenerate PDF" enabled.
This operation makes an HTTP POST request to the /v1/debitmemos/{debitMemoId}/pdfs endpoint.
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 the debit memo that you want to create a PDF file for. For example, 8a8082e65b27f6c3015ba419f3c2644e. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create Taxation Items for Debit Memo
<mule-zuora-connector:create-v1-debitmemos-taxationitems-by-debit-memo-id>
Note: This feature is only available if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support.
This operation creates taxation items for a debit memo and makes an HTTP POST request to the /v1/debitmemos/{debitMemoId}/taxationitems endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Debit Memo Id |
String |
The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create Document Properties
<mule-zuora-connector:create-v1-document-properties>
| This feature is available only if you have the Billing Document Properties Setup feature enabled. The Billing Document Properties Setup feature is in Limited Availability. If you want access to the feature, submit a request at Zuora Global Support. |
This operation creates custom document properties for a billing document. For example, a document property. You can be a custom name used for files generated for billing documents. Billing documents include invoices, credit memos, and debit memos. If you want to configure custom file names for billing documents created through API operations, you have to call this operation before posting the billing documents.
You can create document properties for credit and debit memos only if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support.
This operation makes an HTTP POST request to the /v1/document-properties endpoint.
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](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Multi-entity: Create entity
<mule-zuora-connector:create-v1-entities>
| The Multi-entity feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support. |
You must make the call as a global entity administrator.
Notes
It is best if you assign only one administrator to manage the entity hierarchy, because an administrator of the global entity can, by default, access only the entities that they create themselves.
This operation makes an HTTP POST request to the /v1/entities endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Multi-entity: Initiate Connection
<mule-zuora-connector:create-v1-entity-connections>
The Multi-entity feature is in Limited Availability. If you want access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).
This operation initiates a connection request from a source entity to a target entity.
User Access Permission
You must make the call as a source entity administrator. Also, this administrator must have permission to access to the target entity.
This operation makes an HTTP POST request to the /v1/entity-connections endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Reverse Payment
<mule-zuora-connector:create-v1-gateway-settlement-payments-chargeback-by-payment-id>
Sets the Payment status to "Reversed", creates a refund for the amount specified in the request, and returns the Refund object as response.
This operation makes an HTTP POST request to the /v1/gateway-settlement/payments/{payment-id}/chargeback endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Payment id |
String |
Unique ID of the payment. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Reject Payment
<mule-zuora-connector:create-v1-gateway-settlement-payments-reject-by-payment-id>
Sets the Payment status to "Rejected", creates a refund for the payment amount, and returns the Refund object as response.
This operation makes an HTTP POST request to the /v1/gateway-settlement/payments/{payment-id}/reject endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Payment id |
String |
Unique ID of the payment. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Settle Payment
<mule-zuora-connector:create-v1-gateway-settlement-payments-settle-by-payment-id>
Sets the Payment status to "Settled" and returns the Payment object as response.
This operation makes an HTTP POST request to the /v1/gateway-settlement/payments/{payment-id}/settle endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Payment id |
String |
Unique ID of the payment. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Return HMAC signatures
<mule-zuora-connector:create-v1-hmac-signatures>
This REST API reference describes how to return unique signature and token values that used to process a CORS enabled API call. This operation makes an HTTP POST request to the /v1/hmac-signatures endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create Credit Memo from Invoice
<mule-zuora-connector:create-v1-invoices-creditmemos-by-invoice-id>
This operaton creates an ad-hoc credit memo from an invoice.
| The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support. |
You can create a credit memo from an invoice only if you have the user permission. See Billing Roles for more information.
This operation makes an HTTP POST request to the /v1/invoices/{invoiceId}/creditmemos endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Invoice Id |
String |
The ID of an invoice that you want to create a credit memo from. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora version |
String |
The minor version of the Zuora REST API. See [Minor Version](https://www.zuora.com/developer/api-reference/#section/API-Versions/Minor-Version) for information about REST API version control. This header affects the availability of the following request fields: * |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create debit memo from invoice
<mule-zuora-connector:create-v1-invoices-debitmemos-by-invoice-id>
Note: The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support. Creates an ad-hoc debit memo from an invoice. You can create a debit memo from an invoice only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. This operation makes an HTTP POST request to the /v1/invoices/{invoiceId}/debitmemos endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Invoice Id |
String |
The ID of an invoice that you want to create a debit memo from. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora version |
String |
The minor version of the Zuora REST API. See [Minor Version](https://www.zuora.com/developer/api-reference/#section/API-Versions/Minor-Version) for information about REST API version control. This header affects the availability of the following request fields: * |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Email Invoice
<mule-zuora-connector:create-v1-invoices-emails-by-invoice-id>
Sends a posted invoice to the specified email addresses manually.
Notes
-
You must activate the Manual Email For Invoice | Manual Email For Invoice notification before emailing invoices. To include the invoice PDF in the email, select the Include Invoice PDF check box in the Edit notification dialog from the Zuora UI. See [Create and Edit Notifications](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/C_Create_Notifications#section_2) for more information.
-
Zuora sends the email messages based on the email template you set.
You can set the email template to use in the Delivery Options panel of the Edit notification dialog from the Zuora UI. By default, the Invoice Posted Default Email Template template is used. See [Create and Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information. -
The invoices are sent only to the work email addresses or personal email addresses of the Bill To contact if the following conditions are all met:
-
The
useEmailTemplateSettingfield is set tofalse. -
The email addresses are not specified in the
emailAddressesfield.
-
This operation makes an HTTP POST request to the /v1/invoices/{invoiceId}/emails endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Invoice Id |
String |
The ID of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Upload File for Invoice
<mule-zuora-connector:create-v1-invoices-files-by-invoice-id>
Uploads an externally generated invoice PDF file for an invoice that is in Draft or Posted status. This operation has the following restrictions: - Only the PDF file format is supported. - The maximum size of the PDF file to upload is 4 MB. - A maximum of 50 PDF files can be uploaded for one invoice. This operation makes an HTTP POST request to the /v1/invoices/{invoiceId}/files endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Invoice Id |
String |
The ID of the invoice that you want to upload a PDF file for. For example, 2c92c8955bd63cc1015bd7c151af02ab. |
x |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
File Content |
String |
The content of the 'File' part. |
#[payload] |
|
File Filename |
String |
The filename of the 'File' part (just the name, do not include path). |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create Summary Journal Entry
<mule-zuora-connector:create-v1-journal-entries>
This REST API reference describes how to manually create a summary journal entry. Request and response field descriptions and sample code are provided.
Requirements
-
The sum of debits must equal the sum of credits in the summary journal entry.
-
The following applies only if you use foreign currency conversion:
-
If you have configured Aggregate transactions with different currencies during a Journal Run to "Yes", the value of the currency field must be the same as your tenant’s home currency. That is, you must create journal entries using your home currency.
-
All journal entries in an accounting period must be either all aggregated or all be unaggregated. You cannot have a mix of aggregated and unaggregated journal entries in the same accounting period.
-
This operation makes an HTTP POST request to the /v1/journal-entries endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create Journal Run
<mule-zuora-connector:create-v1-journal-runs>
This REST API reference describes how to create a journal run. Request and response field descriptions and sample code are provided.
This operation makes an HTTP POST request to the /v1/journal-runs endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Create Account
<mule-zuora-connector:create-v1-object-account>
Creates an account without creating any associated objects such as subscriptions. This operation makes an HTTP POST request to the /v1/object/account endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Create Bill Run
<mule-zuora-connector:create-v1-object-bill-run>
| This feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support. |
This operation creates an ad hoc bill run, or a single account, or multiple customer accounts. When creating a single account ad hoc bill run, your request must include AccountId and must not include Batch or BillCycleDay. If more than 500 bill runs are created using this operation are in Pending status, no more bill runs can be created by using this operation.
This operation makes an HTTP POST request to the /v1/object/bill-run endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Create Contact
<mule-zuora-connector:create-v1-object-contact>
Creates a contact for a specified account.
This operation makes an HTTP POST request to the /v1/object/contact endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Create CreditBalanceAdjustment
<mule-zuora-connector:create-v1-object-credit-balance-adjustment>
CRUD: Create CreditBalanceAdjustment This operation makes an HTTP POST request to the /v1/object/credit-balance-adjustment endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Create Export
<mule-zuora-connector:create-v1-object-export>
Use this operation to create a data source export. After you have created a data source export, use [CRUD: Retrieve Export](https://www.zuora.com/developer/api-reference/#operation/Object_GETExport) to check the status of the data source export and access the exported data. When you export data from Zuora, each exported file is available for download for 7 days. Data source exports (Export objects) older than 90 days are automatically deleted. Note: This operation supports the [Export ZOQL](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL) query language. However, this operation does not support some data sources, objects, and fields in Export ZOQL queries. For full compatibility with Export ZOQL, Zuora recommends that you use the [AQuA API](https://knowledgecenter.zuora.com/DC_Developers/T_Aggregate_Query_API) instead of this operation. This operation makes an HTTP POST request to the /v1/object/export endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Object POSTFeature
<mule-zuora-connector:create-v1-object-feature>
This operation makes an HTTP POST request to the /v1/object/feature endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Create Import
<mule-zuora-connector:create-v1-object-import>
Creates a data import. This operation makes an HTTP POST request to the /v1/object/import endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Import Type Content |
String |
The content of the 'Import type' part. |
#[payload] |
|
Name Content |
String |
The content of the 'Name' part. |
x |
|
File Content |
String |
The content of the 'File' part. |
x |
|
File Filename |
String |
The filename of the 'File' part (just the name, do not include path). |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Create InvoiceAdjustment
<mule-zuora-connector:create-v1-object-invoice-adjustment>
CRUD: Create InvoiceAdjustment This operation makes an HTTP POST request to the /v1/object/invoice-adjustment endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Create InvoicePayment
<mule-zuora-connector:create-v1-object-invoice-payment>
CRUD: Create InvoicePayment This operation makes an HTTP POST request to the /v1/object/invoice-payment endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Create payment
<mule-zuora-connector:create-v1-object-payment>
Creates a payment. Note: If you have the Invoice Settlement feature enabled, you cannot use this operation to create a payment. This operation makes an HTTP POST request to the /v1/object/payment endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Create Payment Method
<mule-zuora-connector:create-v1-object-payment-method>
This CRUD operation makes an HTTP POST request to the /v1/object/payment-method endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Create Product
<mule-zuora-connector:create-v1-object-product>
This CRUD operation makes an HTTP POST request to the /v1/object/product endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Create ProductRatePlan
<mule-zuora-connector:create-v1-object-product-rate-plan>
This CRUD operation makes an HTTP POST request to the /v1/object/product-rate-plan endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Create product rate plan charge
<mule-zuora-connector:create-v1-object-product-rate-plan-charge>
Creates a product rate plan charge for a specified rate plan charge. Product rate plan charges can be of three types, one-time fees, recurring fees, and usage fees.
This operation makes an HTTP POST request to the /v1/object/product-rate-plan-charge endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Create Refund
<mule-zuora-connector:create-v1-object-refund>
This CRUD operation makes an HTTP POST request to the /v1/object/refund endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Create TaxationItem
<mule-zuora-connector:create-v1-object-taxation-item>
This CRUD operation makes an HTTP POST request to the /v1/object/taxation-item endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Create UnitOfMeasure
<mule-zuora-connector:create-v1-object-unit-of-measure>
This CRUD operation makes an HTTP POST request to the /v1/object/unit-of-measure endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Create usage
<mule-zuora-connector:create-v1-object-usage>
This CRUD operation makes an HTTP POST request to the /v1/object/usage endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create Billing Preview
<mule-zuora-connector:create-v1-operations-billing-preview>
The Billing Preview feature is in Limited Availability. To have access to the feature, submit a request to Zuora Global Support.
This operation generates a preview of future invoice items for one customer account. Use the BillingPreview call to calculate how much a single customer is invoiced from the most recent invoice to a specific end of term date in the future. Additionally, you can use the BillingPreview service to access real-time data on an individual customer’s usage consumption. The BillingPreview call does not calculate taxes for charges in the subscription.
If you have the Invoice Settlement feature enabled, you can also generate a preview of future credit memo items for one customer account. The Invoice Settlement feature is in Limited Availability. To have access to the feature, submit a request to Zuora Global Support.
This operation makes an HTTP POST request to the /v1/operations/billing-preview endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Invoice and Collect
<mule-zuora-connector:create-v1-operations-invoice-collect>
Generates and posts invoices and credit memos and collects payments for posted invoices. Credit memos are only available if you have the Invoice Settlement feature enabled and negative charges exist. Credit memos will not be applied to invoices.
If draft invoices and credit memos exist when you run this operation, this operation will post the invoices and credit memos. Note that draft credit memos created from an invoice or a product rate plan charge will not be posted.
You can use this operation to generate invoices and collect payments on the posted invoices, or else simply collect payment on a specified existing invoice. The customer’s default payment method is used, and the full amount due is collected. The operation depends on the parameters you specify.
-
To generate one or more new invoices for that customer and collect payment on the generated and other unpaid invoice(s), leave the invoiceId field empty.
-
To collect payment on an existing invoice, specify the invoice ID. The operation is atomic; if any part is unsuccessful, the entire operation is rolled back. When an error occurs, gateway reason codes and error messages are returned the error response of this operation.
The following items are some gateway response code examples:
* Orbital: 05 Do Not Honor; 14 Invalid Credit Card Number
* Vantiv: 301 Invalid Account Number; 304 Lost/Stolen Card
* CyberSource2: 202 Expired card; 231 Invalid account number
For more reason code information, see the corresponding payment gateway documentation.
| Timeouts might occur when using this method on an account that has an extremely high number of subscriptions. |
This operation makes an HTTP POST request to the /v1/operations/invoice-collect endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora version |
String |
The minor version of the Zuora REST API. You need to set this parameter if you use the following fields: * documentDate * targetDate If you have the Invoice Settlement feature enabled, you need to specify this parameter. Otherwise, an error is returned. See [Zuora REST API Versions](https://www.zuora.com/developer/api-reference/#section/API-Versions) for more information. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create Order
<mule-zuora-connector:create-v1-orders>
| This operation is only available if you have the Orders feature enabled. The migration to Orders is in Limited Availability. Feedback is being actively solicited from a small set of early adopters before releasing as generally available. |
You can use this operation to create subscriptions and make changes to subscriptions by creating orders. The following tutorials demonstrate how to use this operation:
Creating a draft order is currently not supported. See Known Limitations in Orders for additional limitations.
Notes
-
When you suspend a subscription using the
suspendorder action, if, in the same "Create order" call, you are going to perform other subsequent order actions on the supscription to suspend, you must first resume the subscription using aresumeorder action. -
When using this operation to create an account, create a subscription, run billing, and collect payment in a single call, if the payment processing fails then all the other steps are rolled back. This means that the invoice will not be generated, the subscription will not be created, and the account will not be created.
Limits
Zuora has the following limits on orders to prevent performance degradation:
-
Up to 50 subscriptions are allowed in a single Create Order operation call.
-
Up to 50 order actions are allowed in a single Create Order operation call.
-
Up to 50 order actions are allowed on a single subscription in a Create Order operation call.
You can request a limit increase by submitting a request at Zuora Global Support.
This operation makes an HTTP POST request to the /v1/orders endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Return Ids |
Boolean |
Specify whether to return IDs associated with the numbers returned in the Create Order operation. |
false |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora version |
String |
The minor version of the Zuora REST API. You need to set this parameter if you use the following fields: * subscriptions * subscriptionNumbers |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Preview Order
<mule-zuora-connector:create-v1-orders-preview>
| This operation is only available if you have the Orders feature enabled. |
The migration to Orders is in Limited Availability. Feedback is being actively solicited from a small set of early adopters before releasing as generally available.
This operation retrieves the preview of the charge metrics and invoice items of a specified order. This operation is only an order preview and no order is created.
Limits
Zuora has the following limits on Orders to prevent performance degradation:
-
Up to 50 subscriptions are allowed in a single Preview Order operation call.
-
Up to 50 order actions are allowed in a single PPreview Order operation call.
-
Up to 50 order actions are allowed on a single subscription in a Preview Order operation call.
You can request a limit increase by submitting a request at Zuora Global Support.
This operation makes an HTTP POST request to the /v1/orders/preview endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create Payment Method
<mule-zuora-connector:create-v1-payment-methods>
You can use this operation to create a payment method for a customer account.
This operation supports the payment methods listed below:
-
PayPal Express Checkout
The following required request body fields are specific to this payment method:-
BAID(required) -
email(required)
-
-
PayPal Native Express Checkout
The following required request body fields are specific to this payment method:-
BAID(required) -
email(optional)
-
-
PayPal Adaptive
The following required request body fields are specific to this payment method:-
preapprovalKey(required) -
email(required)
-
-
Credit Card
This feature is in Limited Availability. Feedback is being actively solicited from a small set of early adopters before being released for general availability.
The following request body fields are specific to this payment method:-
cardHolderInfo(cardHolderNamerequired) -
cardNumber(required) -
cardType(required) -
expirationMonth(required) -
expirationYear(required) -
mitConsentAgreementRef -
mitConsentAgreementSrc -
mitNetworkTransactionId -
mitProfileAction -
mitProfileType -
mitProfileAgreedOn -
securityCode -
checkDuplicated
-
-
ACH
The following request body fields are applicable to this payment method:-
bankABACode(required) -
bankAccountName(required) -
bankAccountNumber(required) -
bankAccountType(required) -
bankName(required) -
addressLine1 -
addressLine2 -
phone -
email -
city -
country -
state -
zipCode
-
-
SEPA
The following request body fields are applicable to this payment method:
-
IBAN(required) -
accountHolderInfo(required) -
businessIdentificationCode
-
-
Betalingsservice (Direct Debit DK)
The following request body fields are applicable to this payment method:-
accountNumber(required) -
identityNumber(required) -
bankCode(required) -
accountHolderInfo(required)
-
-
Autogiro (Direct Debit SE)
The following request body fields are applicable to this payment method:-
accountNumber(required) -
identityNumber(required) -
branchCode(required) -
accountHolderInfo(required)
-
-
Bacs (Direct Debit UK)
The following request body fields are applicable to this payment method:-
accountNumber(required) -
bankCode(required) -
accountHolderInfo(required)
-
This operation makes an HTTP POST request to the /v1/payment-methods endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create Authorization
<mule-zuora-connector:create-v1-payment-methods-authorize-by-payment-method-id>
| If you want this feature enabled, submit a request at Zuora Global Support. |
This operation enables you to authorize the availability of funds for a transaction but delay the capture of funds until a later time. You can subsequently use CRUD: Create payment or Create payment to capture the authorized funds, or use Cancel authorization to cancel the authorization.
The payment gateways that support this operation include Verifi, CyberSource 1.28, CyberSource 1.97, Chase Paymentech Orbital, and Ingenico ePayments.
If you have the Invoice Settlement feature enabled, use the Create payment operation to capture the funds instead of the CRUD: Create payment operation.
This operation makes an HTTP POST request to the /v1/payment-methods/{payment-method-id}/authorize endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Payment method id |
String |
The unique ID of the payment method where the authorization is created. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output. |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create Credit Card Payment Method
<mule-zuora-connector:create-v1-payment-methods-credit-cards>
This REST API reference describes how to create a new credit card payment method for a customer account. This API call is CORS Enabled. Use client-side JavaScript to invoke the call.
| If you use this operation to create credit card payment methods instead of using the iFrame of Hosted Payment Pages, you are subject to PCI-compliance audit requirements. |
This operation makes an HTTP POST request to the /v1/payment-methods/credit-cards endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create Apple Pay Payment Method
<mule-zuora-connector:create-v1-payment-methods-decryption>
The decryption API endpoint can conditionally perform three tasks in one atomic call:
-
Decrypt Apple Pay Payment token
-
Create Credit Card Payment Method in Zuora with decrypted Apple Pay information
-
Process Payment on a specified Invoice (optional)
This operation makes an HTTP POST request to the /v1/payment-methods/decryption endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create Stored Credential Profile
<mule-zuora-connector:create-v1-payment-methods-profiles-by-payment-method-id>
Creates a stored credential profile within a payment method. The stored credential profile represents a consent agreement that you have established with a customer. When you use the payment method in a transaction, Zuora might include information from the stored credential profile to inform the payment processor that the transaction is related to your pre-existing consent agreement with the customer.
| This feature is in Limited Availability. Feedback is being actively solicited from a small set of early adopters before releasing as generally available. |
This operation makes an HTTP POST request to the /v1/payment-methods/{payment-method-id}/profiles endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Payment method id |
String |
ID of a payment method. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Cancel Stored Credential Profile
<mule-zuora-connector:create-v1-payment-methods-profiles-cancel-by-payment-method-id-profile-number>
Cancels a stored credential profile within a payment method. Cancelling the stored credential profile indicates that the stored credentials are no longer valid, per a customer request. You cannot reactivate the stored credential profile after you have cancelled it.
| This feature is in Limited Availability. Feedback is being actively solicited from a small set of early adopters before releasing as generally available. |
This operation makes an HTTP POST request to the /v1/payment-methods/{payment-method-id}/profiles/{profile-number}/cancel endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Payment method id |
String |
ID of a payment method. |
x |
|
Profile number |
Number |
Number that identifies a stored credential profile within the payment method. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO automatically assigns the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Expire Stored Credential Profile
<mule-zuora-connector:create-v1-payment-methods-profiles-expire-by-payment-method-id-profile-number>
Expires a stored credential profile within a payment method. Expiring the stored credential profile indicates that the stored credentials are no longer valid, per an expiration policy in the stored credential transaction framework. You cannot reactivate the stored credential profile after they are expired.
| This feature is in Limited Availability. Feedback is being actively solicited from a small set of early adopters before releasing for general availability. |
This operation makes an HTTP POST request to the /v1/payment-methods/{payment-method-id}/profiles/{profile-number}/expire endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Payment method id |
String |
ID of a payment method. |
x |
|
Profile number |
Number |
Number that identifies a stored credential profile within the payment method. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Cancel Authorization
<mule-zuora-connector:create-v1-payment-methods-void-authorize-by-payment-method-id>
| If you want this feature enabled, submit a request at Zuora Global Support. |
This operation allows you to cancel an authorization. The payment gateways that support this operation include Verifi, CyberSource 1.28, CyberSource 1.97, Chase Paymentech Orbital, and Ingenico ePayments.
This operation makes an HTTP POST request to the /v1/payment-methods/{payment-method-id}/voidAuthorize endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Payment method id |
String |
The unique ID of the payment method where the authorization is cancelled. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create Payment Run
<mule-zuora-connector:create-v1-payment-runs>
Creates a payment run. You can create a payment run to execute immediately after it is created, or a scheduced payment run to execute in future. The accountId, batch, billCycleDay, currency, paymentGatewayId, and billingRunId fields are used to determine which receivables to be paid in the payment run. If none of these fields is specified in the request body, the corresponding payment run collects payments for all accounts.
This operation makes an HTTP POST request to the /v1/payment-runs endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create Payment
<mule-zuora-connector:create-v1-payments>
The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to the feature, submit a request at Zuora Global Support.
This operation creates a payment for the following scenarios:
-
A full payment on an invoice or debit memo
-
A partial payment
-
A payment for several invoices and debit memos
-
An unapplied payment If you do not know to which customer account the payment belongs, you can create a payment without specifying a customer account.
When creating a payment, the total number of invoices and debit memos that the payment applies to must be less than or equal to 1,000.
If the Proration application rule is used when creating a payment, the following quantity must be less than or equal to 10,000:
(number of invoice items + number of debit memo items) * number of payment items
Otherwise, the First In First Out rule is used instead of the Proration rule.
For more information, see Create Payments and Create Payments Without Specifying Customer Accounts.
This operation makes an HTTP POST request to the /v1/payments endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Refund Payment
<mule-zuora-connector:create-v1-payments-refunds-by-payment-id>
The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to the feature, submit a request at Zuora Global Support.
This operation refunds a full or partial unapplied payment to your customers. To refund applied payments, you must unapply the applied payments from the invoices or debit memos, and then refund the unapplied payments to customers.
For more information, see Refund Payments.
This operation makes an HTTP POST request to the /v1/payments/{paymentId}/refunds endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Payment Id |
String |
The unique ID of an unapplied payment. For example, 8a8082e65b27f6c3015b89e4344c16b1. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Generate Quotes Document
<mule-zuora-connector:create-v1-quotes-document>
The document call generates a quote document and returns the generated document URL. You can directly access the generated quote file through the returned URL. The document call should only be used from Zuora Quotes.
File Size Limitation
The maximum export file size is 2047MB. If you have large data requests that go over this limit, you will get the following 403 HTTP response code from Zuora: security:max-object-size>2047MB
Submit a request at Zuora Global Support if you require additional assistance in determining if large file optimization is an option for you.
This operation makes an HTTP POST request to the /v1/quotes/document endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create Revenue Schedule for Credit Memo Item (manual distribution)
<mule-zuora-connector:create-v1-revenue-schedules-credit-memo-items-by-cmi-id>
This feature is available only if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support.
This operation creates a revenue schedule for a credit memo item, and manually distribute the revenue and makes an HTTP POST request to the /v1/revenue-schedules/credit-memo-items/{cmi-id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
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](https://www.zuora.com/developer/api-reference/#operation/GET_CreditMemoItems). |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create Revenue Schedule for Credit Memo Item (distribute by date range)
<mule-zuora-connector:create-v1-revenue-schedules-credit-memo-items-distribute-revenue-with-date-range-by-cmi-id>
Creates a revenue schedule for a credit memo item, and automatically distribute the revenue by specifying the recognition start and end dates.
This feature is available only if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in Limited Availability. If you want access to the feature, submit a request at Zuora Global Support.
This operation makes an HTTP POST request to the /v1/revenue-schedules/credit-memo-items/{cmi-id}/distribute-revenue-with-date-range endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
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](https://www.zuora.com/developer/api-reference/#operation/GET_CreditMemoItems). |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create Revenue Schedule for Debit Memo Item (manual distribution)
<mule-zuora-connector:create-v1-revenue-schedules-debit-memo-items-by-dmi-id>
Creates a revenue schedule to manually distribute revenue for a debit memo item.
This feature is available only if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in Limited Availability. If you want access to the feature, submit a request at Zuora Global Support.
This operation makes an HTTP POST request to the /v1/revenue-schedules/debit-memo-items/{dmi-id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
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](https://www.zuora.com/developer/api-reference/#operation/GET_DebitMemoItems). |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create revenue schedule for debit memo item (distribute by date range)
<mule-zuora-connector:create-v1-revenue-schedules-debit-memo-items-distribute-revenue-with-date-range-by-dmi-id>
Creates a revenue schedule for a debit memo item, and automatically distribute the revenue by specifying the recognition start and end dates.
This feature is only available if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support.
This operation makes an HTTP POST request to the /v1/revenue-schedules/debit-memo-items/{dmi-id}/distribute-revenue-with-date-range endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
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](https://www.zuora.com/developer/api-reference/#operation/GET_DebitMemoItems). |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create revenue schedule for Invoice Item Adjustment (manual distribution)
<mule-zuora-connector:create-v1-revenue-schedules-invoice-item-adjustments-by-invoice-item-adj-key>
Creates a revenue schedule for an Invoice Item Adjustment and manually distribute the revenue. This operation makes an HTTP POST request to the /v1/revenue-schedules/invoice-item-adjustments/{invoice-item-adj-key} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
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 Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create revenue schedule for Invoice Item Adjustment (distribute by
<mule-zuora-connector:create-v1-revenue-schedules-invoice-item-adjustments-distribute-revenue-with-date-range-by-invoice-item-adj-key>
Creates a revenue schedule for an Invoice Item Adjustment and distribute the revenue by specifying the recognition start and end dates. This operation makes an HTTP POST request to the /v1/revenue-schedules/invoice-item-adjustments/{invoice-item-adj-key}/distribute-revenue-with-date-range endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
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 Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create revenue schedule for Invoice Item (manual distribution)
<mule-zuora-connector:create-v1-revenue-schedules-invoice-items-by-invoice-item-id>
Creates a revenue schedule for an Invoice Item and manually distribute the revenue. This operation makes an HTTP POST request to the /v1/revenue-schedules/invoice-items/{invoice-item-id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Invoice item id |
String |
ID of the Invoice Item, for example, e20b07fd416dcfcf0141c81164fd0a75. If the specified Invoice Item is already associated with a revenue schedule, the call fails. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create Revenue Schedule for Invoice Item (distribute by date range)
<mule-zuora-connector:create-v1-revenue-schedules-invoice-items-distribute-revenue-with-date-range-by-invoice-item-id>
Creates a revenue schedule for an Invoice Item and distribute the revenue by specifying the recognition start and end dates. This operation makes an HTTP POST request to the /v1/revenue-schedules/invoice-items/{invoice-item-id}/distribute-revenue-with-date-range endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Invoice item id |
String |
ID of the Invoice Item, for example, e20b07fd416dcfcf0141c81164fd0a75. If the specified Invoice Item is already associated with a revenue schedule, the call fails. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create Revenue Schedule on Subscription Charge
<mule-zuora-connector:create-v1-revenue-schedules-subscription-charges-by-charge-key>
Creates a revenue schedule by specifying the subscription charge. This method is for custom unlimited revenue recognition only.
| You can create a maximum of 3,000 revenue schedules for a subscription charge. |
This operation makes an HTTP POST request to the /v1/revenue-schedules/subscription-charges/{charge-key} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Charge key |
String |
ID of the subscription rate plan charge; for example, 402892793e173340013e173b81000012. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Generate RSA signature
<mule-zuora-connector:create-v1-rsa-signatures>
The REST API used in Payment Pages 2.0 are CORS (Cross-Origin Resource Sharing) enabled and therefore requires a digital signature. The POST rsa_signatures call generates and returns the required digital signature and token for a Payment Pages 2.0 form. You need to pass the generated signature to your client for it to access Payment Pages 2.0. This REST service should be used only when you implement Payment Pages 2.0.
| To avoid potential credit card fraud attacks, secure your Payment Pages from being accessed by fraudulent users before you issue client-side digital signatures and tokens. See Manage Token Issuance for more information. |
This operation makes an HTTP POST request to the /v1/rsa-signatures endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Decrypt RSA signature
<mule-zuora-connector:create-v1-rsa-signatures-decrypt>
The REST API used in Payment Pages 2.0 are CORS (Cross-Origin Resource Sharing) enabled and therefore requires a digital signature. Use rsa_signatures to generate the required digital signature and token for a Payment Pages 2.0 form, and then you use the decrypt REST service to decrypt the signature to validate the signature and key. This REST service should be used only when you implement Payment Pages 2.0.
This operation makes an HTTP POST request to the /v1/rsa-signatures/decrypt endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create sequence sets
<mule-zuora-connector:create-v1-sequence-sets>
Creates sequence sets, allowing distinct numbering sequences for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos. You can create a maximum of 100 sequence sets in one single request. A sequence set comprises a set of custom prefixes and starting numbers that are used for billing documents to generate, and payments and refunds to create. See Prefix and Numbering Configuration for Billing Documents for more information about limitations.
| The Credit and Debit Memos feature is only available if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support. |
This operation makes an HTTP POST request to the /v1/sequence-sets endpoint.
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](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Create subscription
<mule-zuora-connector:create-v1-subscriptions>
This REST API reference describes how to create a new subscription for an existing customer account.
NOTES
If you have the Invoice Settlement feature enabled, it is best practice to set the zuora-version parameter to 211.0 or later. Otherwise, an error occurs. If invoiceCollect is true, the call will not return success = true unless the subscription, invoice, and payment are all successful.
This API operation does not support creating a pending subscription.
Default values for customerAcceptanceDate and serviceActivationDate are set as follows:
serviceActivationDate(SA) specified |
serviceActivationDate (SA) NOT specified |
|
customerAcceptanceDate (CA) specified |
SA uses value in the request call; CA uses value in the request call |
CA uses value in the request call;SA uses CE as default |
customerAcceptanceDate (CA) NOT specified |
SA uses value in the request call; CA uses SA as default |
SA and CA use CE as default |
This operation makes an HTTP POST request to the /v1/subscriptions endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora 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 |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Preview Subscription
<mule-zuora-connector:create-v1-subscriptions-preview>
The REST API reference describes how to create a new subscription in preview mode. This call does not require a valid customer account. It can be used to show potential new customers a preview of a subscription with complete details and charges before creating an account, or to let existing customers preview a subscription with all charges before committing.
Notes
-
The response of the Preview Subscription call is based on the REST API minor version you set in the request header. The response structure might be different if you use different minor version numbers.
-
If you have the Invoice Settlement feature enabled, we recommend that you set the
zuora-versionparameter to207.0or later. Otherwise, an error is returned. -
Default values for customerAcceptanceDate and serviceActivationDate are set as follows:
serviceActivationDate(SA) specified |
serviceActivationDate (SA) NOT specified |
|
customerAcceptanceDate (CA) specified |
SA uses value in the request call; CA uses value in the request call |
CA uses value in the request call;SA uses CE as default |
customerAcceptanceDate (CA) NOT specified |
SA uses value in the request call; CA uses SA as default |
SA and CA use CE as default |
This operation makes an HTTP POST request to the /v1/subscriptions/preview endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora version |
String |
The minor version of the Zuora REST API. You need to set this parameter if you use the following fields: * targetDate * includeExistingDraftDocItems * previewType If you have the Invoice Settlement feature enabled, you need to specify this parameter. Otherwise, an error is returned. See [Zuora REST API Versions](https://www.zuora.com/developer/api-reference/#section/API-Versions) for more information. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Post usage
<mule-zuora-connector:create-v1-usage>
This REST API reference describes how to post or import usage data for one or more accounts in the CSV format. There are no path or query parameters. The data is uploaded using the HTTP multipart/form-data POST method and applied to the user’s tenant.
How this REST API Call Works
The content of the uploaded usage file must follow the format used by the UI import tool. It must be a comma-separated (CSV) file with a corresponding .csv extension. The length of the file name must not exceed 50 characters. The file size must not exceed 4MB. See Downloading the Usage Template to learn about how to download the usage file template.
At the completion of the upload, before the file contents are processed, the API returns a response containing the byte count of the received file and a URL for checking the status of the import process. Of the five possible results displayed at that URL (Pending, Processing, Completed, Canceled, and Failed) only a Completed status indicates that the import was successful.
The operation is atomic, which means that if any record fails, the file is rejected. If a record fails, the entire import is rolled back and all stored data is returned to its original state. To view the actual import status, enter the resulting status URL from the checkImportStatus response using a tool such as POSTMAN. This additional step provides more information about why the import has failed. To manage the information after a successful upload, use the web-based UI.
Usage File Format
The usage file uses the following headings:
| Heading | Description | Required |
|---|---|---|
ACCOUNT_ID |
Enter the account number, for example, the default account number, such as |
Yes |
UOM |
Enter the unit of measure. This must match the UOM for the usage. |
Yes |
QTY |
Enter the quantity. |
Yes |
STARTDATE |
Enter the start date of the usage. This date determines the invoice item service period the associated usage is billed to. Date format is based on locale of the current user. Default date format: |
Yes |
ENDDATE |
Enter the end date of the usage. This is not used in calculations for usage billing and is optional. Date format is based on locale of the current user. Default date format: |
No |
SUBSCRIPTION_ID |
Enter the subscription number or subscription name. If you created the subscription in the Zuora application, Zuora created a number automatically in a format similar to |
No |
CHARGE_ID |
Enter the charge number (not the charge name). You can see the charge ID, for example, |
No |
DESCRIPTION |
Enter a description for the charge. |
No |
This operation makes an HTTP POST request to the /v1/usage endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
File Content |
String |
The content of the 'File' part. |
#[payload] |
|
File Filename |
String |
The filename of the 'File' part (just the name, do not include path). |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Import a workflow
<mule-zuora-connector:create-workflows-import>
Creates a copy of a workflow using the exported JSON document of the original workflow. This operation makes an HTTP POST request to the /workflows/import endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Run a workflow
<mule-zuora-connector:create-workflows-run-by-workflow-id>
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. To learn about how to define parameters, see [Configure the settings of a workflow](https://knowledgecenter.zuora.com/CE_Workflow/Using_Workflow/B_Configure_a_Workflow). This operation makes an HTTP POST request to the /workflows/{workflow_id}/run endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Workflow id |
Number |
The ID of the workflow you want to run. |
x |
|
Authorization |
String |
|
x |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Remove an event trigger
<mule-zuora-connector:delete-events-event-triggers-by-id>
Remove an event trigger This operation makes an HTTP DELETE request to the /events/event-triggers/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
id |
x |
|
Authorization |
String |
|
x |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Delete an email template
<mule-zuora-connector:delete-notifications-email-templates-by-id>
Deletes an email template. This operation makes an HTTP DELETE request to the /notifications/email-templates/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The ID of the email template to be deleted. |
x |
|
Authorization |
String |
|
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Delete a notification definition
<mule-zuora-connector:delete-notifications-notification-definitions-by-id>
Deletes a notification definition. This operation makes an HTTP DELETE request to the /notifications/notification-definitions/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The ID of the notification definition to be deleted. |
x |
|
Authorization |
String |
|
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Delete custom object definition
<mule-zuora-connector:delete-objects-definitions-default-by-object>
Delete the custom object definition for the provided type. Note: A custom object definition can only be deleted if no record of this custom object type exists. This operation makes an HTTP DELETE request to the /objects/definitions/default/{object} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
object |
String |
Specifies the custom object''s API name as object. It is case-sensitive. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Authorization |
String |
|
x |
|
Zuora Version |
String |
API version that determines the response schema. The default version is used if this parameter is not included. Specify |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Delete custom object record
<mule-zuora-connector:delete-objects-records-default-by-object-id>
Delete a custom object record of the given type and id. Note that 200 response will be returned under either of the following conditions:
-
The record is identified and successfully deleted
-
The record could not be found.
Note that the record is deleted immediately and, therefore, will not be retained upon successful deletion.
This operation makes an HTTP DELETE request to the /objects/records/default/{object}/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
object |
String |
Specifies the custom object''s API name as object. It is case-sensitive. |
x |
|
id |
String |
Id identifier in uuid form |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Authorization |
String |
|
x |
|
Zuora Version |
String |
API version that determines the response schema. The default version is used if this parameter is not included. Specify |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Cancel data query job
<mule-zuora-connector:delete-query-jobs-by-job-id>
Cancels a data query job, which prevents Zuora from performing the query. This operation is only applicable if the status of the query job is accepted or in_progress.
This operation makes an HTTP DELETE request to the /query/jobs/{job-id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Job id |
String |
Internal identifier of the query job. |
x |
|
Authorization |
String |
|
x |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Delete Accounting Code
<mule-zuora-connector:delete-v1-accounting-codes-by-ac-id>
This operation makes an HTTP DELETE request to the /v1/accounting-codes/{ac-id} endpoint.
This reference describes how to delete an accounting code through the REST API.
Before You Begin
If you have Zuora Finance enabled on your tenant, then you must have the Delete Unused Accounting Code permission.
Limitations
You can only delete accounting codes that have never been associated with any transactions. An accounting code must be deactivated before you can delete it.
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 delete. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Delete accounting period
<mule-zuora-connector:delete-v1-accounting-periods-by-ap-id>
Deletes an accounting period. This operation makes an HTTP DELETE request to the /v1/accounting-periods/{ap-id} endpoint.
Before You Begin
-
You must have Zuora Finance enabled on your tenant.
-
You must have the Delete Accounting Period user permission.
See Finance Roles.
Limitations
The accounting period to be deleted:
-
Must be the most recent accounting period
-
Must be an open accounting period
-
Must have no revenue distributed into it
-
Must not have any active journal entries
-
Must not be the open-ended accounting period
-
Must not be in the process of running a trial balance
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 Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Delete attachments
<mule-zuora-connector:delete-v1-attachments-by-attachment-id>
Use the Delete Attachment REST request to delete an attachment from a Zuora object. This operation makes an HTTP DELETE request to the /v1/attachments/{attachment-id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Attachment id |
String |
Id of the attachment to be deleted. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Delete credit memo
<mule-zuora-connector:delete-v1-creditmemos-by-credit-memo-id>
Note: The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support. Deletes a credit memo. Only credit memos with the Cancelled status can be deleted. You can delete a credit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. This operation makes an HTTP DELETE request to the /v1/creditmemos/{creditMemoId} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Credit Memo Id |
String |
The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Delete debit memo
<mule-zuora-connector:delete-v1-debitmemos-by-debit-memo-id>
Note: The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support. Deletes a debit memo. Only debit memos with the Cancelled status can be deleted. You can delete a debit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. This operation makes an HTTP DELETE request to the /v1/debitmemos/{debitMemoId} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Debit Memo Id |
String |
The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Delete document properties
<mule-zuora-connector:delete-v1-document-properties-by-document-properties-id>
Note: This feature is available only if you have the Billing Document Properties Setup feature enabled. The Billing Document Properties Setup feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support. Deletes document properties with a specific ID for a billing document. Billing documents include invoices, credit memos, and debit memos. Note: You can delete document properties for credit and debit memos only if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support. This operation makes an HTTP DELETE request to the /v1/document-properties/{documentPropertiesId} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Document Properties Id |
String |
The unique ID of document properties. For example, 402892c74c9193cd014c96bbe7c101f9. |
x |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Multi-entity: Delete Entity
<mule-zuora-connector:delete-v1-entities-by-id>
Note: The Multi-entity feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support.
This operation removes an entity and its sub-entities from a multi-entity hierarchy. You can only remove unprovisioned entities. An error occurred when you remove a provisioned entity.
User Access Permission
You must make the call as a global entity administrator.
This operation makes an HTTP DELETE request to the /v1/entities/{id} endpoint
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 Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Delete summary journal entry
<mule-zuora-connector:delete-v1-journal-entries-by-je-number>
This reference describes how to delete a summary journal entry using the REST API. You must have the "Delete Cancelled Journal Entry" user permission enabled to delete summary journal entries. A summary journal entry must be canceled before it can be deleted. This operation makes an HTTP DELETE request to the /v1/journal-entries/{je-number} endpoint
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 Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Delete journal run
<mule-zuora-connector:delete-v1-journal-runs-by-jr-number>
This reference describes how to delete a journal run using the REST API. You can only delete journal runs that have already been canceled. You must have the "Delete Cancelled Journal Run" Zuora Finance user permission enabled to delete journal runs. This operation makes an HTTP DELETE request to the /v1/journal-runs/{jr-number} endpoint
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 |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Delete account
<mule-zuora-connector:delete-v1-object-account-by-id>
Deletes a specific account asynchronously. Note: When [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) is enabled, before deleting a customer account, you must delete all related orders and subscriptions where this account has been referenced as a subscription owner or invoice owner. This operation makes an HTTP DELETE request to the /v1/object/account/{id} endpoint
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](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Delete amendment
<mule-zuora-connector:delete-v1-object-amendment-by-id>
Invoiced amendments cannot usually be deleted. One exception to this rule is auto-renew amendments. You can delete the last auto-renew amendment even if an invoice has been generated. This operation makes an HTTP DELETE request to the /v1/object/amendment/{id} endpoint
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](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Delete bill run
<mule-zuora-connector:delete-v1-object-bill-run-by-id>
Note: This feature is in Limited Availability. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com). When deleting a bill run, the logic is the same as when using the UI to delete a bill run. The only required parameter is BillRunId. The Status for the bill run must be Canceled to delete a bill run. This operation makes an HTTP DELETE request to the /v1/object/bill-run/{id} endpoint
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](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Delete contact
<mule-zuora-connector:delete-v1-object-contact-by-id>
Deletes a contact. This operation makes an HTTP DELETE request to the /v1/object/contact/{id} endpoint
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](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Delete Feature
<mule-zuora-connector:delete-v1-object-feature-by-id>
CRUD: Delete Feature This operation makes an HTTP DELETE request to the /v1/object/feature/{id} endpoint
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](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Delete InvoiceAdjustment
<mule-zuora-connector:delete-v1-object-invoice-adjustment-by-id>
CRUD: Delete InvoiceAdjustment This operation makes an HTTP DELETE request to the /v1/object/invoice-adjustment/{id} endpoint
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](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Delete invoice
<mule-zuora-connector:delete-v1-object-invoice-by-id>
CRUD: Delete invoice This operation makes an HTTP DELETE request to the /v1/object/invoice/{id} endpoint
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](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Delete InvoiceItemAdjustment
<mule-zuora-connector:delete-v1-object-invoice-item-adjustment-by-id>
This CRUD operation makes an HTTP DELETE request to the /v1/object/invoice-item-adjustment/{id} endpoint.
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](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Delete payment
<mule-zuora-connector:delete-v1-object-payment-by-id>
Deletes a payment. Only payments with the Cancelled status can be deleted. This operation makes an HTTP DELETE request to the /v1/object/payment/{id} endpoint
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](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Delete payment method
<mule-zuora-connector:delete-v1-object-payment-method-by-id>
CRUD: Delete payment method This operation makes an HTTP DELETE request to the /v1/object/payment-method/{id} endpoint
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](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Delete Product
<mule-zuora-connector:delete-v1-object-product-by-id>
CRUD: Delete Product This operation makes an HTTP DELETE request to the /v1/object/product/{id} endpoint
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](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Delete ProductFeature
<mule-zuora-connector:delete-v1-object-product-feature-by-id>
CRUD: Delete ProductFeature This operation makes an HTTP DELETE request to the /v1/object/product-feature/{id} endpoint
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](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Delete ProductRatePlan
<mule-zuora-connector:delete-v1-object-product-rate-plan-by-id>
CRUD: Delete ProductRatePlan This operation makes an HTTP DELETE request to the /v1/object/product-rate-plan/{id} endpoint
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](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Delete product rate plan charge
<mule-zuora-connector:delete-v1-object-product-rate-plan-charge-by-id>
Deletes a product rate plan charge. This operation makes an HTTP DELETE request to the /v1/object/product-rate-plan-charge/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The unique ID of the product rate plan charge to be deleted. For example, 2c93808457d787030157e031fcd34e19. |
x |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Delete refund
<mule-zuora-connector:delete-v1-object-refund-by-id>
CRUD: Delete refund This operation makes an HTTP DELETE request to the /v1/object/refund/{id} endpoint
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](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Delete Subscription
<mule-zuora-connector:delete-v1-object-subscription-by-id>
CRUD: Delete Subscription This operation makes an HTTP DELETE request to the /v1/object/subscription/{id} endpoint
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](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Delete TaxationItem
<mule-zuora-connector:delete-v1-object-taxation-item-by-id>
CRUD: Delete TaxationItem This operation makes an HTTP DELETE request to the /v1/object/taxation-item/{id} endpoint
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](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Delete UnitOfMeasure
<mule-zuora-connector:delete-v1-object-unit-of-measure-by-id>
CRUD: Delete UnitOfMeasure This operation makes an HTTP DELETE request to the /v1/object/unit-of-measure/{id} endpoint
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](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Delete usage
<mule-zuora-connector:delete-v1-object-usage-by-id>
CRUD: Delete usage This operation makes an HTTP DELETE request to the /v1/object/usage/{id} endpoint
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](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Delete Order
<mule-zuora-connector:delete-v1-orders-by-order-number>
This operation deletes a specified order. All the subscriptions changed by this order are deleted. After the deletion, the subscriptions are rolled back to the previous version. You are not allowed to delete an order if the charges that are affected by this order are invoiced. This operation makes an HTTP DELETE request to the /v1/orders/{orderNumber} endpoint.
Note: This operation is only available if you have the Orders feature enabled.
The migration to Orders is in Limited Availability. Feedback is being actively solicited from a small set of early adopters before releasing as generally available.
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 Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Delete payment method
<mule-zuora-connector:delete-v1-payment-methods-by-payment-method-id>
Deletes a credit card payment method from the specified customer account. If the specified payment method is the account’s default payment method, the request fails. In that case, you must first designate a different payment method for that customer to be the default. This operation makes an HTTP DELETE request to the /v1/payment-methods/{payment-method-id} endpoint
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 Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Delete payment run
<mule-zuora-connector:delete-v1-payment-runs-by-payment-run-id>
Deletes a payment run. Only payment runs with the Canceled or Error status can be deleted. This operation makes an HTTP DELETE request to the /v1/payment-runs/{paymentRunId} endpoint
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 |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Delete payment
<mule-zuora-connector:delete-v1-payments-by-payment-id>
Note: The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support. Deletes a payment. Only payments with the Cancelled status can be deleted. If you have the Invoice Settlement feature enabled, overpayments applied to credit balance cannot be deleted. This operation makes an HTTP DELETE request to the /v1/payments/{paymentId} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Payment Id |
String |
The unique ID of an unapplied payment. For example, 8a8082e65b27f6c3015b89e4344c16b1. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Delete refund
<mule-zuora-connector:delete-v1-refunds-by-refund-id>
Note: This feature is only available if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support. Deletes a refund. You can delete a refund with the Canceled or Error status. If you have the Invoice Settlement feature enabled, refunds applied to credit balance cannot be deleted. This operation makes an HTTP DELETE request to the /v1/refunds/{refundId} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Refund Id |
String |
The unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Delete revenue schedule
<mule-zuora-connector:delete-v1-revenue-schedules-by-rs-number>
Deletes a revenue schedule by specifying its revenue schedule number ## Prerequisites You must have the Delete Custom Revenue Schedule permissions in Zuora Finance. This operation makes an HTTP DELETE request to the /v1/revenue-schedules/{rs-number} endpoint
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 Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Delete sequence set
<mule-zuora-connector:delete-v1-sequence-sets-by-id>
Deletes a specific sequence set configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos. Note: The Credit and Debit Memos feature is only available if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support. This operation makes an HTTP DELETE request to the /v1/sequence-sets/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The ID of the sequence set to delete. |
x |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Delete taxation item
<mule-zuora-connector:delete-v1-taxationitems-by-id>
Deletes a specific taxation item by ID. This operation makes an HTTP DELETE request to the /v1/taxationitems/{id} endpoint
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 Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Delete a workflow by ID
<mule-zuora-connector:delete-workflows-by-workflow-id>
Deletes a specific workflow by its ID. This operation makes an HTTP DELETE request to the /workflows/{workflow_id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Workflow id |
String |
The unique ID of a workflow. For example, 19080. |
x |
|
Authorization |
String |
|
x |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Query event triggers
<mule-zuora-connector:get-events-event-triggers>
Query event triggers This operation makes an HTTP GET request to the /events/event-triggers endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Event Type Name |
String |
The event type name. Should be specified in the pattern: ^[A-Za-z]{1,}[\w\-]*$ |
||
Base Object |
String |
The Zuora object that trigger condition is defined upon. Should be specified in the pattern: ^[A-Z][\\w\\-]*$ |
||
start |
Number |
The first index of the query result. Default to 0 if absent, and the minimum is 0. |
0 |
|
limit |
Number |
The maximum number of data records to be returned. Default to 10 if absent. |
10 |
|
active |
String |
The status of the event trigger. |
||
Authorization |
String |
|
x |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get an event trigger by ID
<mule-zuora-connector:get-events-event-triggers-by-id>
Get an event trigger by ID This operation makes an HTTP GET request to the /events/event-triggers/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
id |
x |
|
Authorization |
String |
|
x |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Query email templates
<mule-zuora-connector:get-notifications-email-templates>
Queries email templates. This operation makes an HTTP GET request to the /notifications/email-templates endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
start |
Number |
The first index of the query result. |
1 |
|
limit |
Number |
The maximum number of results the query should return. |
20 |
|
Event Type Name |
String |
The name of the event. |
||
name |
String |
The name of the email template. |
||
Authorization |
String |
|
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get an email template
<mule-zuora-connector:get-notifications-email-templates-by-id>
Queries the email template of the specified ID. This operation makes an HTTP GET request to the /notifications/email-templates/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The ID of the email template. |
x |
|
Authorization |
String |
|
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Query notification definitions
<mule-zuora-connector:get-notifications-notification-definitions>
Queries notification definitions with the specified filters. This operation makes an HTTP GET request to the /notifications/notification-definitions endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Profile Id |
String |
Id of the profile. |
||
Event Type Name |
String |
The name of the event. |
||
start |
Number |
The first index of the query result. |
1 |
|
limit |
Number |
The maximum number of results the query should return. |
20 |
|
Email Template Id |
String |
The ID of the email template. |
||
Authorization |
String |
|
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get a notification definition
<mule-zuora-connector:get-notifications-notification-definitions-by-id>
Queries the notification definition of the given ID. This operation makes an HTTP GET request to the /notifications/notification-definitions/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The ID of the notification definition. |
x |
|
Authorization |
String |
|
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get all custom object definitions
<mule-zuora-connector:get-objects-definitions-default>
Get all custom object definitions This operation makes an HTTP GET request to the /objects/definitions/default endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
select |
Enumeration, one of:
|
If you set |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Authorization |
String |
|
x |
|
Zuora Version |
String |
API version that determines the response schema. The default version is used if this parameter is not included. Specify |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get custom object definition
<mule-zuora-connector:get-objects-definitions-default-by-object>
Get the custom object definition by type for the given tenant. This operation makes an HTTP GET request to the /objects/definitions/default/{object} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
object |
String |
Specifies the custom object''s API name as object. It is case-sensitive. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Authorization |
String |
|
x |
|
Zuora Version |
String |
API version that determines the response schema. The default version is used if this parameter is not included. Specify |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Query custom object records
<mule-zuora-connector:get-objects-records-default-by-object>
Get all object records of the given type. You can also use the q query parameter to filter the output records. ## Limitations This call has the following limitations: * When a record is created, there will be a delay before it is available for search. For example, if you create 5 records and perform a query that these 5 records satisfy the query conditions, there will be a delay between when the 5 records are created, and when all the 5 records can be returned in the query result. This operation makes an HTTP GET request to the /objects/records/default/{object} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
object |
String |
Specifies the custom object''s API name as object. It is case-sensitive. |
x |
|
q |
String |
The query string to filter the records of a custom object. See the [Query syntax of custom object records](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Data_Model/Custom_object_records/Query_syntax_of_custom_object_records) for more information. |
||
ids |
String |
UUIDs of the records to be queried. For example: |
||
Page Size |
Number |
Page size. The value must be between 1 and 1000. |
||
cursor |
String |
The |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Authorization |
String |
|
x |
|
Zuora Version |
String |
API version that determines the response schema. The default version is used if this parameter is not included. Specify |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get custom object record
<mule-zuora-connector:get-objects-records-default-by-object-id>
Get a record of a given type by ID. This operation makes an HTTP GET request to the /objects/records/default/{object}/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
object |
String |
Specifies the custom object''s API name as object. It is case-sensitive. |
x |
|
id |
String |
Id identifier in uuid form |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Authorization |
String |
|
x |
|
Zuora Version |
String |
API version that determines the response schema. The default version is used if this parameter is not included. Specify |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get data query jobs
<mule-zuora-connector:get-query-jobs>
Returns a list of [data query](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query) jobs that have been created in your Zuora tenant. You can filter the list by status. If you are an administrator, you can retrieve all the query jobs in your tenant. Otherwise, you can only retrieve your own query jobs. This operation makes an HTTP GET request to the /query/jobs endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Query Status |
Enumeration, one of:
|
Filters the list of query jobs by status. |
||
Page Size |
Number |
Specifies the maximum number of query jobs to return. |
20 |
|
Authorization |
String |
|
x |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get data query job
<mule-zuora-connector:get-query-jobs-by-job-id>
Retrieves a [data query](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query) job. You can use this operation to track the status of the query job and obtain the URL of the query results. If you are an administrator, you can retrieve every query job in your tenant. If you are a non-admin user and try to retrieve a query job that you are not the owner of, you will get a 403 response indicating that you are forbidden from viewing this job. As a non-admin user, you can only retrieve your own query job. This operation makes an HTTP GET request to the /query/jobs/{job-id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Job id |
String |
Internal identifier of the query job. |
x |
|
Authorization |
String |
|
x |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
List all settings
<mule-zuora-connector:get-settings-listing>
Get a list of all available settings in your tenant.
The response message is in JSON format by default. If you want to receive all the availabe settings in CSV format, include Accept in the header parameters and set it to application/csv. See a 200 response sample in JSON format. See a 200 response sample in CSV format.
You can find a specific operate of an available setting item in your tenant from the 200 response body of this call.
See the following tutorials for the Settings API for how to use a specifc setting item:
This operation makes an HTTP GET request to the /settings/listing endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Authorization |
String |
|
x |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get all Accounting Codes
<mule-zuora-connector:get-v1-accounting-codes>
This reference describes how to query all accounting codes in your chart of accounts through the REST API. This operation makes an HTTP GET request to the /v1/accounting-codes endpoint
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 Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Query an Accounting Code
<mule-zuora-connector:get-v1-accounting-codes-by-ac-id>
This reference describes how to query an accounting code through the REST API. This operation makes an HTTP GET request to the /v1/accounting-codes/{ac-id} endpoint.
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 query. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get all accounting periods
<mule-zuora-connector:get-v1-accounting-periods>
Retrieves all accounting periods on your tenant. This operation makes an HTTP GET request to the /v1/accounting-periods endpoint
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 Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get accounting period
<mule-zuora-connector:get-v1-accounting-periods-by-ap-id>
Retrieves an accounting period. This operation makes an HTTP GET request to the /v1/accounting-periods/{ap-id} endpoint.
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 get. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get job of hard deleting billing document files
<mule-zuora-connector:get-v1-accounts-billing-documents-files-deletion-jobs-by-job-id>
Retrieves information about an asynchronous job of permanently deleting all billing document PDF files for specific accounts. Note: This operation can be used only if you have the Billing user permission "Hard Delete Billing Document Files" enabled. This operation makes an HTTP GET request to the /v1/accounts/billing-documents/files/deletion-jobs/{jobId} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Job Id |
String |
The unique ID of a billing document file deletion job. For example, 2c92c8f83dc4f752013dc72c24ee016c. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get account
<mule-zuora-connector:get-v1-accounts-by-account-key>
Retrieves basic information about a customer account. This operation is a quick retrieval that doesn’t include the account’s subscriptions, invoices, payments, or usage details. Use Get account summary to get more detailed information about an account. This operation makes an HTTP GET request to the /v1/accounts/{account-key} endpoint
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 Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get account summary
<mule-zuora-connector:get-v1-accounts-summary-by-account-key>
Retrieves detailed information about the specified customer account. The response includes the account information and a summary of the account’s subscriptions, invoices, payments, and usages for the last six recently updated subscriptions. ## Notes Returns only the six most recent subscriptions based on the subscription updatedDate. Within those subscriptions, there may be many rate plans and many rate plan charges. These items are subject to the maximum limit on the array size. This operation makes an HTTP GET request to the /v1/accounts/{account-key}/summary endpoint
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 Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get amendments by key
<mule-zuora-connector:get-v1-amendments-by-amendment-key>
Retrieves detailed information about the specified subscription amendment. This operation makes an HTTP GET request to the /v1/amendments/{amendment-key} endpoint
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 Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get amendments by subscription ID
<mule-zuora-connector:get-v1-amendments-subscriptions-by-subscription-id>
Retrieves detailed information about the amendment with the specified subscription. This operation makes an HTTP GET request to the /v1/amendments/subscriptions/{subscription-id} endpoint
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 Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get job status and response
<mule-zuora-connector:get-v1-async-jobs-by-job-id>
Note: This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature enabled. This operation is in Limited Availability. Get the status and response of an asynchronous job. Currently, an asynchronous job created by "Create order asynchronously" or "Preview order asynchronously" is supported. This operation makes an HTTP GET request to the /v1/async-jobs/{jobId} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Job Id |
String |
UUID of the asynchronous job created by an asynchronous API operation. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
View attachments
<mule-zuora-connector:get-v1-attachments-by-attachment-id>
Use the View Attachment REST request to retrieve information about an attachment document. This operation makes an HTTP GET request to the /v1/attachments/{attachment-id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Attachment id |
String |
Id of the attachment you want to view. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
View attachments list
<mule-zuora-connector:get-v1-attachments-by-object-type-object-key>
Use the View Attachment REST request to get a list of attachments on an account, an invoice, or a subscription. This operation makes an HTTP GET request to the /v1/attachments/{object-type}/{object-key} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Object type |
Enumeration, one of:
|
The type of object to list attachements for. |
x |
|
Object key |
String |
ID of the object to list attachements for. - If |
x |
|
Page Size |
Number |
Number of rows returned per page. |
20 |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get billing documents
<mule-zuora-connector:get-v1-billing-documents>
Retrieves the information about all billing documents associated with a specified account. The billing documents contain invoices, credit memos, and debit memos. To retrieve information about credit memos and debit memos, you must have the Invoice Settlement feature enabled. You can use query parameters to restrict the data returned in the response. Examples: - /billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1&sort=+documentDate - /billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1&status=Posted This operation makes an HTTP GET request to the /v1/billing-documents endpoint
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 |
|
Page Size |
Number |
Number of rows returned per page. |
20 |
|
status |
Enumeration, one of:
|
The status of the billing document. |
||
Document Date |
String |
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. |
||
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 |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get Billing Preview Run
<mule-zuora-connector:get-v1-billing-preview-runs-by-billing-preview-run-id>
Note: This feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support. Retrieves a preview of future invoice items for multiple customer accounts through a billing preview run. If you have the Invoice Settlement feature enabled, you can also retrieve a preview of future credit memo items. The Invoice Settlement feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support. A billing preview run asynchronously generates a downloadable CSV file containing a preview of invoice item data and credit memo item data for a batch of customer accounts. This operation makes an HTTP GET request to the /v1/billing-preview-runs/{billingPreviewRunId} endpoint
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 Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get mass action result
<mule-zuora-connector:get-v1-bulk-by-bulk-key>
This reference describes how to get information about the result of a mass action through the REST API. This operation makes an HTTP GET request to the /v1/bulk/{bulk-key} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Bulk key |
String |
String of 32 characters that identifies a mass action. You get the bulk-key after performing a mass action through the REST API. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get product
<mule-zuora-connector:get-v1-catalog-product-by-product-id>
Retrieves detailed information about a specific product, including information about its product rate plans and charges. This operation makes an HTTP GET request to the /v1/catalog/product/{product-id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Product id |
String |
The unique ID of the product you want to retrieve. For example, 8a808255575bdae4015774e9602e16fe. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora version |
String |
The minor version of the Zuora REST API. You only need to set this parameter if you use the |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get Product Catalog
<mule-zuora-connector:get-v1-catalog-products>
Retrieves the entire product catalog, including all products, features, and their corresponding product rate plans, charges. Products are returned in reverse chronological order on the UpdatedDate field. With product rate plans and rate plan charges, the REST API has a maximum array size. This operation makes an HTTP GET request to the /v1/catalog/products endpoint
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. |
10 |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora version |
String |
The minor version of the Zuora REST API. You only need to set this parameter if you use the |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get charge summary details by CRS number
<mule-zuora-connector:get-v1-charge-revenue-summaries-by-crs-number>
This REST API reference describes how to retrieve the details of a charge revenue summary by specifying the charge revenue summary number. The response includes all revenue items associated with the charge revenue summary. This operation makes an HTTP GET request to the /v1/charge-revenue-summaries/{crs-number} endpoint
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 Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get charge summary details by charge ID
<mule-zuora-connector:get-v1-charge-revenue-summaries-subscription-charges-by-charge-key>
This REST API reference describes how to retrieve the details of a charge revenue summary by specifying the subscription charge ID. This response retrieves all revenue items associated with a charge revenue summary. This operation makes an HTTP GET request to the /v1/charge-revenue-summaries/subscription-charges/{charge-key} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Charge key |
String |
ID of the subscription rate plan charge; for example, 402892793e173340013e173b81000012. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get Credit Memos
<mule-zuora-connector:get-v1-creditmemos>
Retrieves the information about all credit memos.
The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request to Zuora Global Support at http://support.zuora.com/.
Filtering
You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body. If the value of a filterable field is string, you can set the corresponding query parameter to null when filtering. Then, you can get the response data with this field value being null.
Examples:
-
/v1/creditmemos?status=Processed
-
/v1/creditmemos?referredInvoiceId=null&status=Draft
-
/v1/creditmemos?status=Processed&type=External&sort=+number
This operation makes an HTTP GET request to the /v1/creditmemos endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Auto Apply Upon Posting |
Boolean |
This parameter filters the response based on the |
false |
|
Target Date |
String |
This parameter filters the response based on the |
||
Unapplied Amount |
Number |
This parameter filters the response based on the |
||
number |
String |
This parameter filters the response based on the |
||
Created By Id |
String |
This parameter filters the response based on the |
||
Referred Invoice Id |
String |
This parameter filters the response based on the |
||
Transferred To Accounting |
Enumeration, one of:
|
This parameter filters the response based on the |
||
Applied Amount |
Number |
This parameter filters the response based on the |
||
Account Id |
String |
This parameter filters the response based on the |
||
amount |
Number |
This parameter filters the response based on the |
||
Tax Amount |
Number |
This parameter filters the response based on the |
||
Exclude From Auto Apply Rules |
Boolean |
This parameter filters the response based on the |
false |
|
Page Size |
Number |
Number of rows returned per page. |
20 |
|
status |
Enumeration, one of:
|
This parameter filters the response based on the |
||
currency |
String |
This parameter filters the response based on the |
||
Refund Amount |
Number |
This parameter filters the response based on the |
||
Updated By Id |
String |
This parameter filters the response based on the |
||
Credit Memo Date |
String |
This parameter filters the response based on the |
||
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 |
||
Total Tax Exempt Amount |
Number |
This parameter filters the response based on the |
||
Updated Date |
String |
This parameter filters the response based on the |
||
Created Date |
String |
This parameter filters the response based on the |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get credit memo
<mule-zuora-connector:get-v1-creditmemos-by-credit-memo-id>
Note: The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support. Retrieves the information about a specific credit memo. This operation makes an HTTP GET request to the /v1/creditmemos/{creditMemoId} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Credit Memo Id |
String |
The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get credit Memo Items
<mule-zuora-connector:get-v1-creditmemos-items-by-credit-memo-id>
The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support. Retrieves the information about all items of a credit memo. A credit memo item is a single line item in a credit memo.
Filtering
You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body. If the value of a filterable field is string, you can set the corresponding query parameter to null when filtering. Then, you can get the response data with this field value being null.
Examples:
-
/v1/creditmemos/402890245c7ca371015c7cb40ac30015/items?amount=100
-
/v1/creditmemos/402890245c7ca371015c7cb40ac30015/items?amount=100&sort=createdDate
This operation makes an HTTP GET request to the /v1/creditmemos/{creditMemoId}/items endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Credit Memo Id |
String |
The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. |
x |
|
Service End Date |
String |
This parameter filters the response based on the |
||
Created By Id |
String |
This parameter filters the response based on the |
||
sku |
String |
This parameter filters the response based on the |
||
Sku Name |
String |
This parameter filters the response based on the |
||
Source Item Id |
String |
This parameter filters the response based on the |
||
Service Start Date |
String |
This parameter filters the response based on the |
||
Subscription Id |
String |
This parameter filters the response based on the |
||
Applied Amount |
Number |
This parameter filters the response based on the |
||
amount |
Number |
This parameter filters the response based on the |
||
id |
String |
This parameter filters the response based on the |
||
Page Size |
Number |
Number of rows returned per page. |
20 |
|
Refund Amount |
Number |
This parameter filters the response based on the |
||
Updated By Id |
String |
This parameter filters the response based on the |
||
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 |
||
Updated Date |
String |
This parameter filters the response based on the |
||
Created Date |
String |
This parameter filters the response based on the |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora version |
String |
The minor version of the Zuora REST API. See [Minor Version](https://www.zuora.com/developer/api-reference/#section/API-Versions/Minor-Version) for information about REST API version control. This header affects the availability of the following response fields: * |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get credit memo item
<mule-zuora-connector:get-v1-creditmemos-items-by-credit-memo-id-cmitemid>
The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support.
Retrieves the information about a specific item of a credit memo. A credit memo item is a single line item in a credit memo. This operation makes an HTTP GET request to the /v1/creditmemos/{creditMemoId}/items/{cmitemid} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
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](https://www.zuora.com/developer/api-reference/#operation/GET_CreditMemoItems). |
x |
|
Credit Memo Id |
String |
The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora version |
String |
The minor version of the Zuora REST API. See [Minor Version](https://www.zuora.com/developer/api-reference/#section/API-Versions/Minor-Version) for information about REST API version control. This header affects the availability of the following response fields: * |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get taxation items of credit memo item
<mule-zuora-connector:get-v1-creditmemos-items-taxation-items-by-credit-memo-id-cmitemid>
Note: The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support. Retrieves information about the taxation items of a specific credit memo item. This operation makes an HTTP GET request to the /v1/creditmemos/{creditMemoId}/items/{cmitemid}/taxation-items endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
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](https://www.zuora.com/developer/api-reference/#operation/GET_CreditMemoItems). |
x |
|
Credit Memo Id |
String |
The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. |
x |
|
Page Size |
Number |
Number of rows returned per page. |
20 |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get credit memo parts
<mule-zuora-connector:get-v1-creditmemos-parts-by-credit-memo-id>
Note: The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support. Retrieves the information about all parts of a credit memo. A credit memo can consist of an unapplied part, and several parts applied to invoices and debit memos. You can use this operation to get all the applied and unapplied portions of a credit memo. This operation makes an HTTP GET request to the /v1/creditmemos/{creditMemoId}/parts endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Credit Memo Id |
String |
The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. |
x |
|
Page Size |
Number |
Number of rows returned per page. |
20 |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get credit memo part
<mule-zuora-connector:get-v1-creditmemos-parts-by-credit-memo-id-partid>
Note: The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support. Retrieves the information about a specific credit memo part. A credit memo can consist of an unapplied part, and several parts applied to invoices and debit memos. This operation makes an HTTP GET request to the /v1/creditmemos/{creditMemoId}/parts/{partid} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
partid |
String |
The unique ID of a specific credit memo part. You can get the credit memo part ID from the response of [Get credit memo parts](https://www.zuora.com/developer/api-reference/#operation/GET_CreditMemoParts). |
x |
|
Credit Memo Id |
String |
The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get credit memo part items
<mule-zuora-connector:get-v1-creditmemos-parts-itemparts-by-credit-memo-id-partid>
Note: The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support. Retrieves the information about all items of a credit memo part. A credit memo part item is a single line item in a credit memo part. A credit memo part can consist of several different types of items. This operation makes an HTTP GET request to the /v1/creditmemos/{creditMemoId}/parts/{partid}/itemparts endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
partid |
String |
The unique ID of a specific credit memo part. You can get the credit memo part ID from the response of [Get credit memo parts](https://www.zuora.com/developer/api-reference/#operation/GET_CreditMemoParts). . |
x |
|
Credit Memo Id |
String |
The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. |
x |
|
Page Size |
Number |
Number of rows returned per page. |
20 |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get credit memo part item
<mule-zuora-connector:get-v1-creditmemos-parts-itemparts-by-credit-memo-id-partid-itempartid>
Note: The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support. Retrieves the information about a specific credit memo part item. A credit memo part item is a single line item in a credit memo part. A credit memo part can consist of several different types of items. This operation makes an HTTP GET request to the /v1/creditmemos/{creditMemoId}/parts/{partid}/itemparts/{itempartid} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
partid |
String |
The unique ID of a specific credit memo part. You can get the credit memo part ID from the response of [Get credit memo parts](https://www.zuora.com/developer/api-reference/#operation/GET_CreditMemoParts). |
x |
|
itempartid |
String |
The unique ID of a specific credit memo part item. You can get the credit memo part item ID from the response of [Get credit memo part items](https://www.zuora.com/developer/api-reference/#operation/GET_CreditMemoItemParts). |
x |
|
Credit Memo Id |
String |
The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get custom foreign currency exchange rates
<mule-zuora-connector:get-v1-custom-exchange-rates-by-currency>
This feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support. This reference describes how to query custom foreign exchange rates from Zuora. You can use this API method to query exchange rates only if you use a custom exchange rate provider and upload rates with the Import Foreign Exchange Rates mass action. This operation makes an HTTP GET request to the /v1/custom-exchange-rates/{currency} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
currency |
String |
The target base currency of the tenant. The exchange rates in the response are calculated in relation to the target currency. The value must be a three-letter currency code, for example, USD. |
x |
|
Start Date |
String |
Start date of the date range for which you want to get exchange rates. The date must be in yyyy-mm-dd format, for example, 2016-01-15. The start date cannot be later than the end date. |
x |
|
End Date |
String |
End date of the date range for which you want to get exchange rates. The date must be in yyyy-mm-dd format, for example, 2016-01-16. The end date can be a maximum of 90 days after the start date. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get Debit Memos
<mule-zuora-connector:get-v1-debitmemos>
Retrieves the information about all debit memos associated with all customer accounts.
Note: The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support. === Filtering
You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body. If the value of a filterable field is string, you can set the corresponding query parameter to null when filtering. Then, you can get the response data with this field value being null.
Examples:
-
/v1/debitmemos?status=Processed
-
/v1/debitmemos?referredInvoiceId=null&status=Draft
-
/v1/debitmemos?status=Processed&type=External&sort=+number
This operation makes an HTTP GET request to the /v1/debitmemos endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Target Date |
String |
This parameter filters the response based on the |
||
number |
String |
This parameter filters the response based on the |
||
Be Applied Amount |
Number |
This parameter filters the response based on the |
||
Created By Id |
String |
This parameter filters the response based on the |
||
Referred Invoice Id |
String |
This parameter filters the response based on the |
||
Debit Memo Date |
String |
This parameter filters the response based on the |
||
balance |
Number |
This parameter filters the response based on the |
||
Account Id |
String |
This parameter filters the response based on the |
||
amount |
Number |
This parameter filters the response based on the |
||
Tax Amount |
Number |
This parameter filters the response based on the |
||
Page Size |
Number |
Number of rows returned per page. |
20 |
|
status |
Enumeration, one of:
|
This parameter filters the response based on the |
||
Due Date |
String |
This parameter filters the response based on the |
||
currency |
String |
This parameter filters the response based on the |
||
Updated By Id |
String |
This parameter filters the response based on the |
||
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 |
||
Total Tax Exempt Amount |
Number |
This parameter filters the response based on the |
||
Updated Date |
String |
This parameter filters the response based on the |
||
Created Date |
String |
This parameter filters the response based on the |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get debit memo application parts
<mule-zuora-connector:get-v1-debitmemos-application-parts-by-debit-memo-id>
This feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support.
Retrieves information about the payments or credit memos that are applied to a specified debit memo.
This operation makes an HTTP GET request to the /v1/debitmemos/{debitMemoId}/application-parts endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Debit Memo Id |
String |
The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get Debit Memo
<mule-zuora-connector:get-v1-debitmemos-by-debit-memo-id>
This feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support.
Retrieves the information about a specific debit memo.
This operation makes an HTTP GET request to the /v1/debitmemos/{debitMemoId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Debit Memo Id |
String |
The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get Debit Memo Items
<mule-zuora-connector:get-v1-debitmemos-items-by-debit-memo-id>
Note: The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support.
Retrieves the information about all items of a debit memo. A debit memo item is a single line item in a debit memo.
Filtering
You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body. If the value of a filterable field is string, you can set the corresponding query parameter to null when filtering. Then, you can get the response data with this field value being null.
Examples:
-
/v1/debitmemos/402890245c7ca371015c7cb40b28001f/items?amount=100
-
/v1/debitmemos/402890245c7ca371015c7cb40b28001f/items?amount=100&sort=createdDate
This operation makes an HTTP GET request to the /v1/debitmemos/{debitMemoId}/items endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Debit Memo Id |
String |
The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e. |
x |
|
Service End Date |
String |
This parameter filters the response based on the |
||
Be Applied Amount |
Number |
This parameter filters the response based on the |
||
Created By Id |
String |
This parameter filters the response based on the |
||
sku |
String |
This parameter filters the response based on the |
||
Sku Name |
String |
This parameter filters the response based on the |
||
Source Item Id |
String |
This parameter filters the response based on the |
||
Service Start Date |
String |
This parameter filters the response based on the |
||
Subscription Id |
String |
This parameter filters the response based on the |
||
amount |
Number |
This parameter filters the response based on the |
||
id |
String |
This parameter filters the response based on the |
||
Page Size |
Number |
Number of rows returned per page. |
20 |
|
Updated By Id |
String |
This parameter filters the response based on the |
||
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 |
||
Updated Date |
String |
This parameter filters the response based on the |
||
Created Date |
String |
This parameter filters the response based on the |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora version |
String |
The minor version of the Zuora REST API. See [Minor Version](https://www.zuora.com/developer/api-reference/#section/API-Versions/Minor-Version) for information about REST API version control. This header affects the availability of the following response fields: * |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get Debit Memo Item
<mule-zuora-connector:get-v1-debitmemos-items-by-debit-memo-id-dmitemid>
Note: The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support.
Retrieves information about a specific item of a debit memo. A debit memo item is a single line item in a debit memo.
This operation makes an HTTP GET request to the /v1/debitmemos/{debitMemoId}/items/{dmitemid} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
dmitemid |
String |
The unique ID of a debit memo item. You can get the debit memo item ID from the response of [Get debit memo items](https://www.zuora.com/developer/api-reference/#operation/GET_DebitMemoItems). |
x |
|
Debit Memo Id |
String |
The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora version |
String |
The minor version of the Zuora REST API. See [Minor Version](https://www.zuora.com/developer/api-reference/#section/API-Versions/Minor-Version) for information about REST API version control. This header affects the availability of the following response fields: * |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get taxation items of debit memo item
<mule-zuora-connector:get-v1-debitmemos-items-taxation-items-by-debit-memo-id-dmitemid>
Note: The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support. Retrieves information about the taxation items of a specific debit memo item. This operation makes an HTTP GET request to the /v1/debitmemos/{debitMemoId}/items/{dmitemid}/taxation-items endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
dmitemid |
String |
The unique ID of a debit memo item. You can get the debit memo item ID from the response of [Get debit memo items](https://www.zuora.com/developer/api-reference/#operation/GET_DebitMemoItems). |
x |
|
Debit Memo Id |
String |
The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e. |
x |
|
Page Size |
Number |
Number of rows returned per page. |
20 |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Describe object
<mule-zuora-connector:get-v1-describe-by-object>
Provides a reference listing for each object that is available in your Zuora tenant. The information returned by this call is useful if you are using CRUD: Create Export or the AQuA API to create a data source export. See Export ZOQL for more information.
Response
The response contains an XML document that lists the fields of the specified object. Each of the object’s fields is represented by an element in the XML document. Each field element contains the following elements:
Element |
Description |
|
API name of the field. |
|
Name of the field in the Zuora user interface. |
|
Data type of the field. The possible data types are: |
|
Specifies the availability of the field. If the |
The <field> element contains other elements that provide legacy information about the field. This information is not directly related to the REST API.
Response sample:
<?xml version="1.0" encoding="UTF-8"?>
<object>
<name>ProductRatePlanCharge</name>
<label>Product Rate Plan Charge</label>
<fields>
...
<field>
<name>TaxMode</name>
<label>Tax Mode</label>
<type>picklist</type>
<options>
<option>TaxExclusive</option>
<option>TaxInclusive</option>
</options>
<contexts>
<context>export</context>
</contexts>
...
</field>
...
</fields>
</object>It is strongly recommended that your integration checks <contexts> elements in the response. If your integration does not check <contexts> elements, your integration may process fields that are not available for use in data source exports. See Changes to the Describe API for more information.
This operation makes an HTTP GET request to the /v1/describe/{object} endpoint.
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, |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get document properties
<mule-zuora-connector:get-v1-document-properties-by-document-type-document-id>
This feature is available only if you have the Billing Document Properties Setup feature enabled. The Billing Document Properties Setup feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support.
You can retrieve information about document properties of a billing document. Billing documents include invoices, credit memos, and debit memos. Note: You can retrieve information about document properties of credit and debit memos only if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support.
This operation makes an HTTP GET request to the /v1/document-properties/{documentType}/{documentId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Document Type |
Enumeration, one of:
|
The type of the billing document. |
x |
|
Document Id |
String |
The unique ID of document properties to be retrieved. For example, 402892c74c9193cd014c96bbe7c101f9. |
x |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Multi-entity: Get entities
<mule-zuora-connector:get-v1-entities>
The Multi-entity feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support.
Retrieves detailed information of certain entities in a multi-entity hierarchy.
You can retrieve:
-
Provisioned entities
-
Unprovisioned entities
-
Both provisioned and unprovisioned entities
User Access Permission
You can make the call as any entity user.
This operation makes an HTTP GET request to the /v1/entities endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
provisioned |
String |
Specify whether to retrieve provisioned or unprovisioned entities: - |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Multi-entity: Get entity by Id
<mule-zuora-connector:get-v1-entities-by-id>
The Multi-entity feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support.
Retrieves detailed information about a specified entity.
User Access Permission
You can make the call as any entity user.
This operation makes an HTTP GET request to the /v1/entities/{id} endpoint.
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 retrieve. You can get the entity Id from the GET Entities call. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Multi-entity: Get connections
<mule-zuora-connector:get-v1-entity-connections>
The Multi-entity feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support.
Retrieves information about certain connections for a specified entity. You can specify the entity to retrieve in the Zuora-Entity-Ids request header.
You can retrieve:
-
Inbound connections
-
Outbound connections
-
Both inbound and outbound connections
User Access Permission
You can make the call as any entity user.
This operation makes an HTTP GET request to the /v1/entity-connections endpoint.
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. |
30 |
|
type |
Enumeration, one of:
|
Specifies whether to retrieve inbound or outbound connections for an entity. Possible values: - |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get files
<mule-zuora-connector:get-v1-files-by-file-id>
Retrieve files such as export results, invoices, and accounting period reports.
The maximum file size is 2047MB. If you have a data request that exceeds this limit, Zuora returns the following 403 response: 2047MB. Submit a request at Zuora Global Support to determine if large file optimization is an option for you.
|
This operation makes an HTTP GET request to the /v1/files/{file-id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
File id |
String |
The Zuora ID of the file to retrieve. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Return Hosted Pages
<mule-zuora-connector:get-v1-hostedpages>
Returns the Payment Pages configuration metadata, specifically, page ID, page version, payment method type.
The following are the version-specific and general REST requests for Payment Pages:
-
The request for Payment Pages 1.0 configuration information:
GET /hostedpages?version=1 -
The request for Payment Pages 2.0 configuration information:
GET /hostedpages?version=2 -
The request for all versions of Payment Pages configuration information:
GET /hostedpages
Notes
If you do not have the corresponding tenant setting enabled, for example, the request version parameter set to 2 with the Payment Pages 2.0 setting disabled, you will receive an error.
This operation makes an HTTP GET request to the /v1/hostedpages endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Version Number |
String |
Version of the Payment Pages for which you want to retrieve the configuration information. Specify 1 for Payment Pages 1.0 or 2 for Payment Pages 2.0. If omitted, information for all versions of Payment Pages are returned. The response also depends on your tenant settings for Payment Pages 1.0 and Payment Pages 2.0. For example, if only the tenant setting for Payment Pages 2.0 is enabled, the response will only contain information for Payment Pages 2.0 forms even when this parameter is omitted. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get invoice application parts
<mule-zuora-connector:get-v1-invoices-application-parts-by-invoice-id>
Note: The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you wish to have access to the feature, submit a request at Zuora Global Support. Retrieves information about the payments or credit memos that are applied to a specified invoice. This operation makes an HTTP GET request to the /v1/invoices/{invoiceId}/application-parts endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Invoice Id |
String |
The unique ID of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get invoice files
<mule-zuora-connector:get-v1-invoices-files-by-invoice-id>
Retrieves the information about all PDF files of a specified invoice. Invoice PDF files are returned in reverse chronological order by the value of the versionNumber field. This operation makes an HTTP GET request to the /v1/invoices/{invoiceId}/files endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Invoice Id |
String |
The unique ID of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab. |
x |
|
Page Size |
Number |
Number of rows returned per page. |
20 |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get invoice items
<mule-zuora-connector:get-v1-invoices-items-by-invoice-id>
Retrieves the information about all items of a specified invoice. This operation makes an HTTP GET request to the /v1/invoices/{invoiceId}/items endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Invoice Id |
String |
The unique ID of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab. |
x |
|
Page Size |
Number |
Number of rows returned per page. |
20 |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get taxation items of invoice item
<mule-zuora-connector:get-v1-invoices-items-taxation-items-by-invoice-id-item-id>
Retrieves information about the taxation items of a specific invoice item. This operation makes an HTTP GET request to the /v1/invoices/{invoiceId}/items/{itemId}/taxation-items endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Invoice Id |
String |
The unique ID of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab. |
x |
|
Item Id |
String |
The unique ID of an invoice item. For example, 2c86c8955bd63cc1015bd7c151af02ef. |
x |
|
Page Size |
Number |
Number of rows returned per page. |
20 |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get summary journal entry
<mule-zuora-connector:get-v1-journal-entries-by-je-number>
This REST API reference describes how to get information about a summary journal entry by its journal entry number. This operation makes an HTTP GET request to the /v1/journal-entries/{je-number} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Je number |
String |
Je number |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get all summary journal entries in a journal run
<mule-zuora-connector:get-v1-journal-entries-journal-runs-by-jr-number>
This REST API reference describes how to retrieve information about all summary journal entries in a journal run. This operation makes an HTTP GET request to the /v1/journal-entries/journal-runs/{jr-number} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Jr number |
String |
Journal run number. |
x |
|
Page Size |
Number |
Number of rows returned per page. |
8 |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get journal run
<mule-zuora-connector:get-v1-journal-runs-by-jr-number>
This REST API reference describes how to get information about a journal run. Request and response field descriptions and sample code are provided. This operation makes an HTTP GET request to the /v1/journal-runs/{jr-number} endpoint
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 |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get callout notification histories
<mule-zuora-connector:get-v1-notification-history-callout>
This REST API reference describes how to get a notification history for callouts. This operation makes an HTTP GET request to the /v1/notification-history/callout endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Start Time |
String |
The initial date and time of records to be returned. Defaults to (end time - 1 day). Use format yyyy-MM-ddTHH:mm:ss. |
||
Event Category |
String |
Category of records to be returned by event category. The following formats are supported: * |
||
Failed Only |
Boolean |
If |
false |
|
End Time |
String |
The final date and time of records to be returned. Defaults to now. Use format yyyy-MM-ddTHH:mm:ss. |
||
Page Size |
Number |
Number of rows returned per page. |
20 |
|
Object Id |
String |
The ID of an object that triggered a callout notification. |
||
Include Response Content |
Boolean |
Include Response Content |
false |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get email notification histories
<mule-zuora-connector:get-v1-notification-history-email>
This REST API reference describes how to get a notification history for notification emails. ## Notes Request parameters and their values may be appended with a "?" following the HTTPS GET request. Additional request parameter are separated by "&". For example: GET https://rest.zuora.com/v1/notification-history/email?startTime=2015-01-12T00:00:00&endTime=2015-01-15T00:00:00&failedOnly=false&eventCategory=1000&pageSize=1 This operation makes an HTTP GET request to the /v1/notification-history/email endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Start Time |
String |
The initial date and time of records to be returned. Defaults to (end time - 1 day). Use format yyyy-MM-ddTHH:mm:ss. The maximum date range (endTime - startTime) is three days. |
||
Event Category |
String |
Category of records to be returned by event category. The following formats are supported: * |
||
Failed Only |
Boolean |
If |
false |
|
End Time |
String |
The end date and time of records to be returned. Defaults to now. Use format yyyy-MM-ddTHH:mm:ss. The maximum date range (endTime - startTime) is three days. |
||
Page Size |
Number |
Number of rows returned per page. |
20 |
|
Object Id |
String |
The Id of an object that triggered an email notification. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Get account
<mule-zuora-connector:get-v1-object-account-by-id>
Retrieves the information about one specific account. This operation makes an HTTP GET request to the /v1/object/account/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
fields |
String |
Object fields to return |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Get amendment
<mule-zuora-connector:get-v1-object-amendment-by-id>
CRUD: Get amendment This operation makes an HTTP GET request to the /v1/object/amendment/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
fields |
String |
Object fields to return |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Get bill run
<mule-zuora-connector:get-v1-object-bill-run-by-id>
Note: This feature is in Limited Availability. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com). Business operations depending on the completion of the bill run will not be available while the bill run query returns PostInProgress. Upon completion of the bill run, a query will return Posted. This operation makes an HTTP GET request to the /v1/object/bill-run/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
fields |
String |
Object fields to return |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Retrieve CommunicationProfile
<mule-zuora-connector:get-v1-object-communication-profile-by-id>
CRUD: Retrieve CommunicationProfile This operation makes an HTTP GET request to the /v1/object/communication-profile/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
fields |
String |
Object fields to return |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Get contact
<mule-zuora-connector:get-v1-object-contact-by-id>
Retrieves detailed information about a specific contact. This operation makes an HTTP GET request to the /v1/object/contact/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
fields |
String |
Object fields to return |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Retrieve CreditBalanceAdjustment
<mule-zuora-connector:get-v1-object-credit-balance-adjustment-by-id>
CRUD: Retrieve CreditBalanceAdjustment This operation makes an HTTP GET request to the /v1/object/credit-balance-adjustment/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
fields |
String |
Object fields to return |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Retrieve Export
<mule-zuora-connector:get-v1-object-export-by-id>
Use this operation to check the status of a data source export and access the exported data. When you export data from Zuora, each exported file is available for download for 7 days. Data source exports (Export objects) older than 90 days are automatically deleted. This operation makes an HTTP GET request to the /v1/object/export/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
fields |
String |
Object fields to return |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Retrieve Feature
<mule-zuora-connector:get-v1-object-feature-by-id>
CRUD: Retrieve Feature This operation makes an HTTP GET request to the /v1/object/feature/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
fields |
String |
Object fields to return |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Retrieve Import
<mule-zuora-connector:get-v1-object-import-by-id>
CRUD: Retrieve Import This operation makes an HTTP GET request to the /v1/object/import/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
fields |
String |
Object fields to return |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Retrieve InvoiceAdjustment
<mule-zuora-connector:get-v1-object-invoice-adjustment-by-id>
CRUD: Retrieve InvoiceAdjustment This operation makes an HTTP GET request to the /v1/object/invoice-adjustment/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
fields |
String |
Object fields to return |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Get invoice
<mule-zuora-connector:get-v1-object-invoice-by-id>
CRUD: Get invoice This operation makes an HTTP GET request to the /v1/object/invoice/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
fields |
String |
Object fields to return |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Retrieve InvoiceItemAdjustment
<mule-zuora-connector:get-v1-object-invoice-item-adjustment-by-id>
CRUD: Retrieve InvoiceItemAdjustment This operation makes an HTTP GET request to the /v1/object/invoice-item-adjustment/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
fields |
String |
Object fields to return |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Retrieve InvoiceItem
<mule-zuora-connector:get-v1-object-invoice-item-by-id>
CRUD: Retrieve InvoiceItem This operation makes an HTTP GET request to the /v1/object/invoice-item/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
fields |
String |
Object fields to return |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Retrieve InvoicePayment
<mule-zuora-connector:get-v1-object-invoice-payment-by-id>
CRUD: Retrieve InvoicePayment This operation makes an HTTP GET request to the /v1/object/invoice-payment/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
fields |
String |
Object fields to return |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Retrieve InvoiceSplit
<mule-zuora-connector:get-v1-object-invoice-split-by-id>
CRUD: Retrieve InvoiceSplit This operation makes an HTTP GET request to the /v1/object/invoice-split/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
fields |
String |
Object fields to return |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Retrieve InvoiceSplitItem
<mule-zuora-connector:get-v1-object-invoice-split-item-by-id>
CRUD: Retrieve InvoiceSplitItem This operation makes an HTTP GET request to the /v1/object/invoice-split-item/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
fields |
String |
Object fields to return |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Get payment
<mule-zuora-connector:get-v1-object-payment-by-id>
Retrieves the information about one specific payment. This operation makes an HTTP GET request to the /v1/object/payment/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The unique ID of a payment. For example, 2c92c095592623ea01596621ada84352. |
x |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Get payment method
<mule-zuora-connector:get-v1-object-payment-method-by-id>
CRUD: Get payment method This operation makes an HTTP GET request to the /v1/object/payment-method/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
fields |
String |
Object fields to return |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Get payment method snapshot
<mule-zuora-connector:get-v1-object-payment-method-snapshot-by-id>
This REST API reference describes how to retrieve a Payment Method Snapshot. A Payment Method Snapshot is a copy of the particular Payment Method used in a transaction. If the Payment Method is deleted, the Payment Method Snapshot continues to retain the data used in each of the past transactions. ## Notes The following Payment Method fields are not available in Payment Method Snapshots: * Active * AchAddress1 * AchAddress2 * CreatedById * CreatedDate * UpdatedById * UpdatedDate The Payment Method Snapshot field PaymentMethodId is not available in Payment Methods. This operation makes an HTTP GET request to the /v1/object/payment-method-snapshot/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
fields |
String |
Object fields to return |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Retrieve PaymentMethodTransactionLog
<mule-zuora-connector:get-v1-object-payment-method-transaction-log-by-id>
CRUD: Retrieve PaymentMethodTransactionLog This operation makes an HTTP GET request to the /v1/object/payment-method-transaction-log/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
fields |
String |
Object fields to return |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Get payment transaction log
<mule-zuora-connector:get-v1-object-payment-transaction-log-by-id>
Retrieves information about a specific payment transaction log. This operation makes an HTTP GET request to the /v1/object/payment-transaction-log/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The ID of a payment transaction log. |
x |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Retrieve Product
<mule-zuora-connector:get-v1-object-product-by-id>
CRUD: Retrieve Product This operation makes an HTTP GET request to the /v1/object/product/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
fields |
String |
Object fields to return |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Retrieve ProductFeature
<mule-zuora-connector:get-v1-object-product-feature-by-id>
CRUD: Retrieve ProductFeature This operation makes an HTTP GET request to the /v1/object/product-feature/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
fields |
String |
Object fields to return |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Retrieve ProductRatePlan
<mule-zuora-connector:get-v1-object-product-rate-plan-by-id>
CRUD: Retrieve ProductRatePlan This operation makes an HTTP GET request to the /v1/object/product-rate-plan/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
fields |
String |
Object fields to return |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Get product rate plan charge
<mule-zuora-connector:get-v1-object-product-rate-plan-charge-by-id>
CRUD: Get product rate plan charge This operation makes an HTTP GET request to the /v1/object/product-rate-plan-charge/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The unique ID of a product rate plan charge to be retrieved. For example, 2c93808457d787030157e031fcd34e19. |
x |
|
fields |
String |
Object fields to return |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Retrieve ProductRatePlanChargeTier
<mule-zuora-connector:get-v1-object-product-rate-plan-charge-tier-by-id>
CRUD: Retrieve ProductRatePlanChargeTier This operation makes an HTTP GET request to the /v1/object/product-rate-plan-charge-tier/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
fields |
String |
Object fields to return |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Retrieve RatePlan
<mule-zuora-connector:get-v1-object-rate-plan-by-id>
CRUD: Retrieve RatePlan This operation makes an HTTP GET request to the /v1/object/rate-plan/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
fields |
String |
Object fields to return |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Get rate plan charge
<mule-zuora-connector:get-v1-object-rate-plan-charge-by-id>
CRUD: Get rate plan charge This operation makes an HTTP GET request to the /v1/object/rate-plan-charge/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
fields |
String |
Object fields to return |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Retrieve RatePlanChargeTier
<mule-zuora-connector:get-v1-object-rate-plan-charge-tier-by-id>
CRUD: Retrieve RatePlanChargeTier This operation makes an HTTP GET request to the /v1/object/rate-plan-charge-tier/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
fields |
String |
Object fields to return |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Get refund
<mule-zuora-connector:get-v1-object-refund-by-id>
CRUD: Get refund This operation makes an HTTP GET request to the /v1/object/refund/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
fields |
String |
Object fields to return |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Retrieve RefundInvoicePayment
<mule-zuora-connector:get-v1-object-refund-invoice-payment-by-id>
CRUD: Retrieve RefundInvoicePayment This operation makes an HTTP GET request to the /v1/object/refund-invoice-payment/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
fields |
String |
Object fields to return |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Retrieve RefundTransactionLog
<mule-zuora-connector:get-v1-object-refund-transaction-log-by-id>
CRUD: Retrieve RefundTransactionLog This operation makes an HTTP GET request to the /v1/object/refund-transaction-log/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
fields |
String |
Object fields to return |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Retrieve Subscription
<mule-zuora-connector:get-v1-object-subscription-by-id>
CRUD: Retrieve Subscription This operation makes an HTTP GET request to the /v1/object/subscription/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
fields |
String |
Object fields to return |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Retrieve SubscriptionProductFeature
<mule-zuora-connector:get-v1-object-subscription-product-feature-by-id>
CRUD: Retrieve SubscriptionProductFeature This operation makes an HTTP GET request to the /v1/object/subscription-product-feature/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
fields |
String |
Object fields to return |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Retrieve TaxationItem
<mule-zuora-connector:get-v1-object-taxation-item-by-id>
CRUD: Retrieve TaxationItem This operation makes an HTTP GET request to the /v1/object/taxation-item/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
fields |
String |
Object fields to return |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Retrieve UnitOfMeasure
<mule-zuora-connector:get-v1-object-unit-of-measure-by-id>
CRUD: Retrieve UnitOfMeasure This operation makes an HTTP GET request to the /v1/object/unit-of-measure/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
fields |
String |
Object fields to return |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Get usage
<mule-zuora-connector:get-v1-object-usage-by-id>
CRUD: Get usage This operation makes an HTTP GET request to the /v1/object/usage/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
fields |
String |
Object fields to return |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get all orders
<mule-zuora-connector:get-v1-orders>
Note: This feature is only available if you have the [Order Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) feature enabled. The migration to Order Metrics is in Limited Availability. We are actively soliciting feedback from a small set of early adopters before releasing as generally available. If you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders) feature enabled, you already have the Order Metrics feature enabled. Retrieves information about all orders in your tenant. By default, it returns the first page of the orders. This operation makes an HTTP GET request to the /v1/orders endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
End Date |
String |
The result will only contains orders with the date of dateFilterOption earlier than or equal to this date. |
||
Date Filter Option |
String |
The date type to filter on. This field value can be orderDate or updatedDate. Default is orderDate. |
||
Page Size |
Number |
Number of rows returned per page. |
20 |
|
Start Date |
String |
The result will only contain the orders with the date of dateFilterOption later than or equal to this date. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get an order
<mule-zuora-connector:get-v1-orders-by-order-number>
Note: This feature is only available if you have the [Order Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) feature enabled. The migration to Order Metrics is in Limited Availability. We are actively soliciting feedback from a small set of early adopters before releasing as generally available. If you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders) feature enabled, you already have the Order Metrics feature enabled. Retrieves the detailed information about a specified order. This operation makes an HTTP GET request to the /v1/orders/{orderNumber} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Order Number |
String |
The order number to be retrieved. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get order metrics for evergreen subscription
<mule-zuora-connector:get-v1-orders-evergreen-metrics-by-order-number-subscription-number>
Note: This feature is only available if you have the [Order Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) feature enabled. The migration to Order Metrics is in Limited Availability. We are actively soliciting feedback from a small set of early adopters before releasing as generally available. If you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders) feature enabled, you already have the Order Metrics feature enabled. Retrieves the metrics of an evergreen subscription in a specified order. This operation makes an HTTP GET request to the /v1/orders/{orderNumber}/evergreenMetrics/{subscriptionNumber} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Order Number |
String |
The order number. |
x |
|
Subscription Number |
String |
The subscription number you want to get the metrics for. |
x |
|
Start Date |
String |
The start date of the date range for which you want to get the metrics. The date must be in yyyy-mm-dd format. For example, 2017-12-03. |
x |
|
End Date |
String |
The end date of the date range for which you want to get the metrics. The date must be in yyyy-mm-dd format. For example, 2017-12-03. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get orders by invoice owner
<mule-zuora-connector:get-v1-orders-invoice-owner-by-account-number>
Note: This feature is only available if you have the [Order Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) feature enabled. The migration to Order Metrics is in Limited Availability. We are actively soliciting feedback from a small set of early adopters before releasing as generally available. If you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders) feature enabled, you already have the Order Metrics feature enabled. Retrieves the detailed information about all orders for a specified invoice owner. This operation makes an HTTP GET request to the /v1/orders/invoiceOwner/{accountNumber} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Number |
String |
The invoice owner account number. |
x |
|
End Date |
String |
The result will only contain the orders with the date of dateFilterOption earlier than or equal to this date. |
||
Date Filter Option |
String |
The date type to filter on. This field value can be orderDate or updatedDate. Default is orderDate. |
||
Page Size |
Number |
Number of rows returned per page. |
20 |
|
Start Date |
String |
The result will only contain the orders with the date of dateFilterOption later than or equal to this date. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get orders by subscription number
<mule-zuora-connector:get-v1-orders-subscription-by-subscription-number>
Note: This feature is only available if you have the [Order Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) feature enabled. The migration to Order Metrics is in Limited Availability. We are actively soliciting feedback from a small set of early adopters before releasing as generally available. If you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders) feature enabled, you already have the Order Metrics feature enabled. Retrieves the detailed information about all orders for a specified subscription. Any orders containing the changes on the specified subscription are returned. This operation makes an HTTP GET request to the /v1/orders/subscription/{subscriptionNumber} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Subscription Number |
String |
The subscription number. |
x |
|
End Date |
String |
The result will only contain the orders with the date of 'dateFilterOption' earlier than or equal to this date. |
||
Date Filter Option |
String |
The date type to filter on. This field value can be 'orderDate' or 'updatedDate'. Default is orderDate. |
||
Page Size |
Number |
Number of rows returned per page. |
20 |
|
Start Date |
String |
The result will only contain the orders with the date of 'dateFilterOption' later than or equal to this date. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get orders by subscription owner
<mule-zuora-connector:get-v1-orders-subscription-owner-by-account-number>
Note: This feature is only available if you have the [Order Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) feature enabled. The migration to Order Metrics is in Limited Availability. We are actively soliciting feedback from a small set of early adopters before releasing as generally available. If you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders) feature enabled, you already have the Order Metrics feature enabled. Retrieves the detailed information about all orders for a specified subscription owner. Any orders containing the changes on the subscriptions owned by this account are returned. This operation makes an HTTP GET request to the /v1/orders/subscriptionOwner/{accountNumber} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Number |
String |
The subscription owner account number. |
x |
|
End Date |
String |
The result will only contain the orders with the date of 'dateFilterOption' earlier than or equal to this date. |
||
Date Filter Option |
String |
The date type to filter on. This field value can be 'orderDate' or 'updatedDate'. Default is orderDate. |
||
Page Size |
Number |
Number of rows returned per page. |
20 |
|
Start Date |
String |
The result will only contain the orders with the date of 'dateFilterOption' later than or equal to this date. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get term information for subscription
<mule-zuora-connector:get-v1-orders-term-by-subscription-number>
Note: This feature is only available if you have the [Order Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) feature enabled. The migration to Order Metrics is in Limited Availability. We are actively soliciting feedback from a small set of early adopters before releasing as generally available. If you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders) feature enabled, you already have the Order Metrics feature enabled. Retrieves the terms of the specified subscription. This operation makes an HTTP GET request to the /v1/orders/term/{subscriptionNumber} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Subscription Number |
String |
The number of the subscription to retrieve terms for. For example, A-S00000001. |
x |
|
version |
Number |
The version of the subscription to retrieve terms for. If you do not specify this parameter, Zuora returns the terms for the latest version of the subscription. |
||
Page Size |
Number |
Number of rows returned per page. |
20 |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get credit card payment methods for account
<mule-zuora-connector:get-v1-payment-methods-credit-cards-accounts-by-account-key>
This REST API reference describes how to retrieve all credit card information for the specified customer account. ## Notes The response includes details of credit or debit cards for the specified customer account. Card numbers are masked, e.g., "**1234". Cards are returned in reverse chronological order of last update. You can send requests for bank transfer or ACH type payment methods. However, the response will not include effective details of these payment methods. This operation makes an HTTP GET request to the /v1/payment-methods/credit-cards/accounts/{account-key} endpoint
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 |
|
Page Size |
Number |
Number of rows returned per page. |
20 |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get stored credential profiles
<mule-zuora-connector:get-v1-payment-methods-profiles-by-payment-method-id>
Retrieves the stored credential profiles within a payment method. Note: This feature is in Limited Availability. We are actively soliciting feedback from a small set of early adopters before releasing as generally available. This operation makes an HTTP GET request to the /v1/payment-methods/{payment-method-id}/profiles endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Payment method id |
String |
ID of a payment method. |
x |
|
Include All |
Boolean |
Specifies whether to retrieve all the stored credential profiles within the payment method. By default, Zuora returns only the stored credential profiles with |
false |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get payment runs
<mule-zuora-connector:get-v1-payment-runs>
Retrieves the information about all payment runs. You can define filterable fields to restrict the data returned in the response. # Filtering You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body. If the value of a filterable field is string, you can set the corresponding query parameter to null when filtering. Then, you can get the response data with this field value being null. Examples: - /v1/payment-runs?status=Processed - /v1/payment-runs?targetDate=2017-10-10&status=Pending - /v1/payment-runs?status=Completed&sort=+updatedDate This operation makes an HTTP GET request to the /v1/payment-runs endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Target Date |
String |
This parameter filters the response based on the |
||
Created By Id |
String |
This parameter filters the response based on the |
||
Page Size |
Number |
Number of rows returned per page. |
20 |
|
status |
Enumeration, one of:
|
This parameter filters the response based on the |
||
Updated By Id |
String |
This parameter filters the response based on the |
||
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 |
||
Updated Date |
String |
This parameter filters the response based on the |
||
Created Date |
String |
This parameter filters the response based on the |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get payment run
<mule-zuora-connector:get-v1-payment-runs-by-payment-run-id>
Retrieves the information about a specific payment run. This operation makes an HTTP GET request to the /v1/payment-runs/{paymentRunId} endpoint
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 |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get payment run summary
<mule-zuora-connector:get-v1-payment-runs-summary-by-payment-run-id>
Retrieves the summary of a payment run. This operation makes an HTTP GET request to the /v1/payment-runs/{paymentRunId}/summary endpoint
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 |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get payment gateways
<mule-zuora-connector:get-v1-paymentgateways>
Retrieves the basic information about all the payment gateways. This operation makes an HTTP GET request to the /v1/paymentgateways endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get all payments
<mule-zuora-connector:get-v1-payments>
Note: The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support. Retrieves the information about all payments from all your customer accounts. # Filtering You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body. If the value of a filterable field is string, you can set the corresponding query parameter to null when filtering. Then, you can get the response data with this field value being null. Examples: - /v1/payments?status=Processed - /v1/payments?currency=USD&status=Processed - /v1/payments?status=Processed&type=External&sort=+number This operation makes an HTTP GET request to the /v1/payments endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Unapplied Amount |
Number |
This parameter filters the response based on the |
||
number |
String |
This parameter filters the response based on the |
||
Created By Id |
String |
This parameter filters the response based on the |
||
Applied Amount |
Number |
This parameter filters the response based on the |
||
Account Id |
String |
This parameter filters the response based on the |
||
Credit Balance Amount |
Number |
This parameter filters the response based on the |
||
amount |
Number |
This parameter filters the response based on the |
||
Page Size |
Number |
Number of rows returned per page. |
20 |
|
status |
Enumeration, one of:
|
This parameter filters the response based on the |
||
Effective Date |
String |
This parameter filters the response based on the |
||
currency |
String |
This parameter filters the response based on the |
||
Refund Amount |
Number |
This parameter filters the response based on the |
||
Updated By Id |
String |
This parameter filters the response based on the |
||
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 |
||
type |
Enumeration, one of:
|
This parameter filters the response based on the |
||
Updated Date |
String |
This parameter filters the response based on the |
||
Created Date |
String |
This parameter filters the response based on the |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get payment
<mule-zuora-connector:get-v1-payments-by-payment-id>
Note: The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support. Retrieves the information about one specific payment. This operation makes an HTTP GET request to the /v1/payments/{paymentId} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Payment Id |
String |
The unique ID of a payment. For example, 8a8082e65b27f6c3015b89e4344c16b1. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get payment parts
<mule-zuora-connector:get-v1-payments-parts-by-payment-id>
Note: The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support. Retrieves the information about all parts of a payment. A payment can consist of an unapplied part, and several parts applied to invoices and debit memos. You can use this operation to get all the applied and unapplied portions of a payment. This operation makes an HTTP GET request to the /v1/payments/{paymentId}/parts endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Payment Id |
String |
The unique ID of a payment. For example, 8a8082e65b27f6c3015b89e4344c16b1. |
x |
|
Page Size |
Number |
Number of rows returned per page. |
20 |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get payment part
<mule-zuora-connector:get-v1-payments-parts-by-payment-id-partid>
Note: The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support. Retrieves the information about a specific payment part. A payment can consist of an unapplied part, and several parts applied to invoices and debit memos. This operation makes an HTTP GET request to the /v1/payments/{paymentId}/parts/{partid} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
partid |
String |
The unique ID of a specific payment part. You can get the payment part ID from the response of [Get payment parts](https://www.zuora.com/developer/api-reference/#operation/GET_PaymentParts). |
x |
|
Payment Id |
String |
The unique ID of a payment. For example, 8a8082e65b27f6c3015b89e4344c16b1. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get payment part items
<mule-zuora-connector:get-v1-payments-parts-itemparts-by-payment-id-partid>
Note: The Invoice Item Settlement feature is in Limited Availability, and it must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos). If you want access to this feature, submit a request at Zuora Global Support. Retrieves the information about all items of a payment part. A payment part item is a single line item in a payment part. A payment part can consist of several different types of items. This operation makes an HTTP GET request to the /v1/payments/{paymentId}/parts/{partid}/itemparts endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
partid |
String |
The unique ID of a specific payment part. You can get the payment part ID from the response of [Get payment parts](https://www.zuora.com/developer/api-reference/#operation/GET_PaymentParts). |
x |
|
Payment Id |
String |
The unique ID of a payment. For example, 8a8082e65b27f6c3015b89e4344c16b1. |
x |
|
Page Size |
Number |
Number of rows returned per page. |
20 |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get payment part item
<mule-zuora-connector:get-v1-payments-parts-itemparts-by-payment-id-partid-itempartid>
Note: The Invoice Item Settlement feature is in Limited Availability, and it must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos). If you want access to this feature, submit a request at Zuora Global Support. Retrieves the information about a specific payment part item. A payment part item is a single line item in a payment part. A payment part can consist of several different types of items. This operation makes an HTTP GET request to the /v1/payments/{paymentId}/parts/{partid}/itemparts/{itempartid} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
partid |
String |
The unique ID of a specific payment part. You can get the payment part ID from the response of [Get payment parts](https://www.zuora.com/developer/api-reference/#operation/GET_PaymentParts). |
x |
|
itempartid |
String |
The unique ID of a specific payment part item. You can get the payment part item ID from the response of [Get payment part items](https://www.zuora.com/developer/api-reference/#operation/GET_PaymentItemParts). |
x |
|
Payment Id |
String |
The unique ID of a payment. For example, 8a8082e65b27f6c3015b89e4344c16b1. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get product rate plans
<mule-zuora-connector:get-v1-rateplan-product-rate-plan-by-product-id>
Retrieves information about all product rate plans of a specific product. This operation makes an HTTP GET request to the /v1/rateplan/{product_id}/productRatePlan endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Product id |
String |
The unique ID of a product. For example, 2c92c0f96487e16a016487f663c71a61. |
x |
|
Page Size |
Number |
Number of rows returned per page. |
20 |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get all refunds
<mule-zuora-connector:get-v1-refunds>
Note: This feature is only available if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support. Retrieves the information about all refunds. Two types of refunds are available, electronic refunds and external refunds. # Filtering You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body. If the value of a filterable field is string, you can set the corresponding query parameter to null when filtering. Then, you can get the response data with this field value being null. Examples: - /v1/refunds?status=Processed - /v1/refunds?amount=4&status=Processed - /v1/refunds?status=Processed&type=External&sort=+number This operation makes an HTTP GET request to the /v1/refunds endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
number |
String |
This parameter filters the response based on the |
||
Created By Id |
String |
This parameter filters the response based on the |
||
Payment Id |
String |
This parameter filters the response based on the |
||
Account Id |
String |
This parameter filters the response based on the |
||
amount |
Number |
This parameter filters the response based on the |
||
Page Size |
Number |
Number of rows returned per page. |
20 |
|
Method Type |
Enumeration, one of:
|
This parameter filters the response based on the |
||
status |
Enumeration, one of:
|
This parameter filters the response based on the |
||
Updated By Id |
String |
This parameter filters the response based on the |
||
Refund Date |
String |
This parameter filters the response based on the |
||
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 |
||
type |
Enumeration, one of:
|
This parameter filters the response based on the |
||
Updated Date |
String |
This parameter filters the response based on the |
||
Created Date |
String |
This parameter filters the response based on the |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get refund
<mule-zuora-connector:get-v1-refunds-by-refund-id>
Note: This feature is only available if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support. Retrieves the information about a specific refund. This operation makes an HTTP GET request to the /v1/refunds/{refundId} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Refund Id |
String |
The unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get refund parts
<mule-zuora-connector:get-v1-refunds-parts-by-refund-id>
Note: This feature is only available if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support. Retrieves the information about all parts of a refund. This operation makes an HTTP GET request to the /v1/refunds/{refundId}/parts endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Refund Id |
String |
The unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get refund part
<mule-zuora-connector:get-v1-refunds-parts-by-refund-id-refundpartid>
Note: This feature is only available if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support. Retrieves the information about a specific refund part. This operation makes an HTTP GET request to the /v1/refunds/{refundId}/parts/{refundpartid} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
refundpartid |
String |
The unique ID of a specific refund part. You can get the refund part ID from the response of [Get refund parts](https://www.zuora.com/developer/api-reference/#operation/GET_RefundParts). |
x |
|
Refund Id |
String |
The unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get refund part items
<mule-zuora-connector:get-v1-refunds-parts-itemparts-by-refund-id-refundpartid>
Note: The Invoice Item Settlement feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support. Retrieves the information about all items of a refund part. A refund part item is a single line item in a refund part. A refund part can consist of several different types of items. This operation makes an HTTP GET request to the /v1/refunds/{refundId}/parts/{refundpartid}/itemparts endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
refundpartid |
String |
The unique ID of a specific refund part. You can get the refund part ID from the response of [Get refund parts](https://www.zuora.com/developer/api-reference/#operation/GET_RefundParts). |
x |
|
Refund Id |
String |
The unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9. |
x |
|
Page Size |
Number |
Number of rows returned per page. |
20 |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get refund part item
<mule-zuora-connector:get-v1-refunds-parts-itemparts-by-refund-id-refundpartid-itempartid>
Note: The Invoice Item Settlement feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support. Retrieves the information about a specific refund part item. A refund part item is a single line item in a refund part. A refund part can consist of several different types of items. This operation makes an HTTP GET request to the /v1/refunds/{refundId}/parts/{refundpartid}/itemparts/{itempartid} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
itempartid |
String |
The unique ID of a specific refund part item. You can get the refund part item ID from the response of [Get refund part items](https://www.zuora.com/developer/api-reference/#operation/GET_RefundItemParts). |
x |
|
refundpartid |
String |
The unique ID of a specific refund part. You can get the refund part ID from the response of [Get refund parts](https://www.zuora.com/developer/api-reference/#operation/GET_RefundParts). |
x |
|
Refund Id |
String |
The unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get revenue event details
<mule-zuora-connector:get-v1-revenue-events-by-event-number>
This REST API reference describes how to get revenue event details by specifying the revenue event number. Request and response field descriptions and sample code are provided. This operation makes an HTTP GET request to the /v1/revenue-events/{event-number} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Event number |
String |
The number associated with the revenue event. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get revenue events for a revenue schedule
<mule-zuora-connector:get-v1-revenue-events-revenue-schedules-by-rs-number>
This REST API reference describes how to get all revenue events in a revenue schedule by specifying the revenue schedule number. Request and response field descriptions and sample code are provided. This operation makes an HTTP GET request to the /v1/revenue-events/revenue-schedules/{rs-number} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Rs number |
String |
Revenue schedule number. The revenue schedule number is always prefixed with "RS", for example, "RS-00000001". |
x |
|
Page Size |
Number |
Number of rows returned per page. |
8 |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get revenue items by charge revenue summary number
<mule-zuora-connector:get-v1-revenue-items-charge-revenue-summaries-by-crs-number>
This REST API reference describes how to get the details for each revenue item in a charge revenue summary by specifying the charge revenue summary number. Request and response field descriptions and sample code are provided. This operation makes an HTTP GET request to the /v1/revenue-items/charge-revenue-summaries/{crs-number} endpoint
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 |
|
Page Size |
Number |
Number of rows returned per page. |
300 |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get revenue items by revenue event number
<mule-zuora-connector:get-v1-revenue-items-revenue-events-by-event-number>
This REST API reference describes how to get the details of each revenue item in a revenue event by specifying the revenue event number. Request and response field descriptions and sample code are provided. This operation makes an HTTP GET request to the /v1/revenue-items/revenue-events/{event-number} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Event number |
String |
The number associated with the revenue event. |
x |
|
Page Size |
Number |
Number of rows returned per page. |
300 |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get revenue items by revenue schedule
<mule-zuora-connector:get-v1-revenue-items-revenue-schedules-by-rs-number>
This REST API reference describes how to get the details for each revenue items in a revenue schedule by specifying the revenue schedule number. Request and response field descriptions and sample code are provided. This operation makes an HTTP GET request to the /v1/revenue-items/revenue-schedules/{rs-number} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Rs number |
String |
Revenue schedule number. The revenue schedule number is always prefixed with "RS", for example, "RS-00000001". |
x |
|
Page Size |
Number |
Number of rows returned per page. |
300 |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get revenue recognition rule by product rate plan charge
<mule-zuora-connector:get-v1-revenue-recognition-rules-product-charges-by-charge-key>
Note: This feature is only available if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support. Retrieves the revenue recognition rule associated with a production rate plan charge by specifying the charge ID. This operation makes an HTTP GET request to the /v1/revenue-recognition-rules/product-charges/{charge-key} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Charge key |
String |
The unique ID of a product rate plan charge. For example, 8a8082e65ba86084015bb323d3c61d82. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get revenue recognition rule by subscription charge
<mule-zuora-connector:get-v1-revenue-recognition-rules-subscription-charges-by-charge-key>
Retrieves the revenue recognition rule associated with a subscription charge by specifying the charge ID. Request and response field descriptions and sample code are provided. This operation makes an HTTP GET request to the /v1/revenue-recognition-rules/subscription-charges/{charge-key} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Charge key |
String |
The unique ID of the subscription rate plan charge. For example, 402892793e173340013e173b81000012. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get revenue schedule details
<mule-zuora-connector:get-v1-revenue-schedules-by-rs-number>
Retrieves the details of a revenue schedule by specifying the revenue schedule number. Request and response field descriptions and sample code are provided. This operation makes an HTTP GET request to the /v1/revenue-schedules/{rs-number} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Rs number |
String |
Revenue schedule number. The revenue schedule number is always prefixed with "RS", for example, "RS-00000001". |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get revenue schedule by credit memo item ID
<mule-zuora-connector:get-v1-revenue-schedules-credit-memo-items-by-cmi-id>
Note: This feature is only available if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support. Retrieves the details about a revenue schedule by specifying a valid credit memo item ID. This operation makes an HTTP GET request to the /v1/revenue-schedules/credit-memo-items/{cmi-id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
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](https://www.zuora.com/developer/api-reference/#operation/GET_CreditMemoItems). |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get revenue schedule by debit memo item ID
<mule-zuora-connector:get-v1-revenue-schedules-debit-memo-items-by-dmi-id>
Note: This feature is only available if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support. Retrieves the details about a revenue schedule by specifying a valid debit memo item ID. This operation makes an HTTP GET request to the /v1/revenue-schedules/debit-memo-items/{dmi-id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
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](https://www.zuora.com/developer/api-reference/#operation/GET_DebitMemoItems). |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get revenue schedule by invoice item adjustment
<mule-zuora-connector:get-v1-revenue-schedules-invoice-item-adjustments-by-invoice-item-adj-key>
Retrieves the details of a revenue schedule by specifying a valid invoice item adjustment identifier. Request and response field descriptions and sample code are provided. This operation makes an HTTP GET request to the /v1/revenue-schedules/invoice-item-adjustments/{invoice-item-adj-key} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Invoice item adj key |
String |
ID of the Invoice Item Adjustment, for example, e20b07fd416dcfcf0141c81164fd0a72. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get revenue schedule by invoice item ID
<mule-zuora-connector:get-v1-revenue-schedules-invoice-items-by-invoice-item-id>
Retrieves the details of a revenue schedule by specifying the invoice item ID. This operation makes an HTTP GET request to the /v1/revenue-schedules/invoice-items/{invoice-item-id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Invoice item id |
String |
A valid Invoice Item ID. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get all revenue schedules of product charge by charge ID and billing
<mule-zuora-connector:get-v1-revenue-schedules-product-charges-by-charge-key-account-key>
Note: This feature is only available if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support. Retrieves the details about all revenue schedules of a product rate plan charge by specifying the charge ID and billing account ID. This operation makes an HTTP GET request to the /v1/revenue-schedules/product-charges/{charge-key}/{account-key} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account key |
String |
The account number or account ID. |
x |
|
Charge key |
String |
The unique ID of a product rate plan charge. For example, 8a8082e65ba86084015bb323d3c61d82. |
x |
|
Page Size |
Number |
Number of rows returned per page. |
8 |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get revenue schedule by subscription charge
<mule-zuora-connector:get-v1-revenue-schedules-subscription-charges-by-charge-key>
Retrieves the revenue schedule details by specifying subscription charge ID. Request and response field descriptions and sample code are provided This operation makes an HTTP GET request to the /v1/revenue-schedules/subscription-charges/{charge-key} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Charge key |
String |
ID of the subscription rate plan charge; for example, 402892793e173340013e173b81000012. |
x |
|
Page Size |
Number |
Number of rows returned per page. |
8 |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get sequence sets
<mule-zuora-connector:get-v1-sequence-sets>
Retrieves information about all sequence sets configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos. You can use query parameters to restrict the data returned in the response. Note: The Credit and Debit Memos feature is only available if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support. This operation makes an HTTP GET request to the /v1/sequence-sets endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Page Size |
Number |
Number of rows returned per page. |
20 |
|
name |
String |
The name of a specific sequence set. |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get sequence set
<mule-zuora-connector:get-v1-sequence-sets-by-id>
Retrieves information about a specific sequence set configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos Note: The Credit and Debit Memos feature is only available if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support. This operation makes an HTTP GET request to the /v1/sequence-sets/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The ID of the sequence set to retrieve information about. |
x |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get the revenue automation start date
<mule-zuora-connector:get-v1-settings-finance-revenue-automation-start-date>
This REST API reference describes how to get the revenue automation start date. Request and response field descriptions and sample code are provided. This operation makes an HTTP GET request to the /v1/settings/finance/revenue-automation-start-date endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get subscriptions by account
<mule-zuora-connector:get-v1-subscriptions-accounts-by-account-key>
Retrieves all subscriptions associated with the specified account. Zuora only returns the latest version of the subscriptions. Subscription data is returned in reverse chronological order based on updatedDate. This operation makes an HTTP GET request to the /v1/subscriptions/accounts/{account-key} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account key |
String |
Possible values are: * an account number * an account ID |
x |
|
Page Size |
Number |
Number of rows returned per page. |
20 |
|
Charge detail |
String |
The segmented rate plan charges. When an amendment results in a change to a charge, Zuora creates a segmented rate plan charge. Use this field to track segment charges. Possible values are: * last-segment: (Default) The last rate plan charge on the subscription. The last rate plan charge is the last one in the order of time on the subscription rather than the most recent changed charge on the subscription. * current-segment: The segmented charge that is active on today’s date (effectiveStartDate <= today’s date < effectiveEndDate). * all-segments: All the segmented charges. The |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get subscriptions by key
<mule-zuora-connector:get-v1-subscriptions-by-subscription-key>
This REST API reference describes how to retrieve detailed information about a specified subscription in the latest version. This operation makes an HTTP GET request to the /v1/subscriptions/{subscription-key} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Subscription key |
String |
Possible values are: * a subscription number * a subscription ID |
x |
|
Charge detail |
String |
The segmented rate plan charges. When an amendment results in a change to a charge, Zuora creates a segmented rate plan charge. Use this field to track segment charges. Possible values are: * last-segment: (Default) The last rate plan charge on the subscription. The last rate plan charge is the last one in the order of time on the subscription rather than the most recent changed charge on the subscription. * current-segment: The segmented charge that is active on today’s date (effectiveStartDate <= today’s date < effectiveEndDate). * all-segments: All the segmented charges. The |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get subscriptions by key and version
<mule-zuora-connector:get-v1-subscriptions-versions-by-subscription-key-version>
This REST API reference describes how to retrieve detailed information about a specified subscription in a specified version. When you create a subscription amendment, you create a new version of the subscription. You can use this method to retrieve information about a subscription in any version. This operation makes an HTTP GET request to the /v1/subscriptions/{subscription-key}/versions/{version} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Subscription key |
String |
Subscription number. For example, A-S00000135. |
x |
|
version |
String |
Subscription version. For example, 1. |
x |
|
Charge detail |
String |
The segmented rate plan charges. When an amendment results in a change to a charge, Zuora creates a segmented rate plan charge. Use this field to track segment charges. Possible values are: * last-segment: (Default) The last rate plan charge on the subscription. The last rate plan charge is the last one in the order of time on the subscription rather than the most recent changed charge on the subscription. * current-segment: The segmented charge that is active on today’s date (effectiveStartDate <= today’s date < effectiveEndDate). * all-segments: All the segmented charges. The |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get taxation item
<mule-zuora-connector:get-v1-taxationitems-by-id>
Retrieves the information about a specific taxation item by ID. This operation makes an HTTP GET request to the /v1/taxationitems/{id} endpoint
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 Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get invoices
<mule-zuora-connector:get-v1-transactions-invoices-accounts-by-account-key>
Retrieves invoices for a specified account. Invoices are returned in reverse chronological order by updatedDate. This operation makes an HTTP GET request to the /v1/transactions/invoices/accounts/{account-key} endpoint
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 |
|
Page Size |
Number |
Number of rows returned per page. |
20 |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get payments
<mule-zuora-connector:get-v1-transactions-payments-accounts-by-account-key>
Retrieves payments for a specified account. Payments are returned in reverse chronological order by updatedDate. This operation makes an HTTP GET request to the /v1/transactions/payments/accounts/{account-key} endpoint
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 |
|
Page Size |
Number |
Number of rows returned per page. |
20 |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get usage
<mule-zuora-connector:get-v1-usage-accounts-by-account-key>
This REST API reference describes how to retrieve usage details for an account. Usage data is returned in reverse chronological order. This operation makes an HTTP GET request to the /v1/usage/accounts/{account-key} endpoint
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 |
|
Page Size |
Number |
Number of rows returned per page. |
20 |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Initial Page Number |
Number |
The initial page to get in the first request |
1 |
|
Output Mime Type |
String |
The mime type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Multi-entity: Get entities that a user can access
<mule-zuora-connector:get-v1-users-accessible-entities-by-username>
Note: The Multi-entity feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support. Retrieves detailed information about all the entities that a user has permission to access. ## User Access Permission You can make the call as any entity user. This operation makes an HTTP GET request to the /v1/users/{username}/accessible-entities endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
username |
String |
Specify the login user name that you want to retrieve. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get workflows
<mule-zuora-connector:get-workflows>
Retrieves a list of workflows available in your Zuora tenant. This operation makes an HTTP GET request to the /workflows endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
name |
String |
If specified, the operation retrieves the workflow that is in the specified name. |
||
Callout trigger |
Boolean |
If set to true, the operation retrieves workflows that have the callout trigger enabled. If set to false, the operation retrieves workflows that have the callout trigger disabled. If not specified, the operation will not use this filter. |
false |
|
page |
Number |
If you want to retrieve only the workflows on a specific page, you can specify the |
1 |
|
interval |
String |
A CRON expession that specifies a schedule (for example, |
||
Ondemand trigger |
Boolean |
If set to true, the operation retrieves workflows that have the ondemand trigger enabled. If set to false, the operation retrieves workflows that have the ondemand trigger disabled. If not specified, the operation will not use this filter. |
false |
|
Page length |
Number |
The number of workflows shown in a single call. If the |
20 |
|
Scheduled trigger |
Boolean |
If set to true, the operation retrieves workflows that have the scheduled trigger enabled. If set to false, the operation retrieves workflows that have the scheduled trigger disabled. If not specfied, the operation will not use this filter. |
false |
|
Authorization |
String |
|
x |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get a workflow by ID
<mule-zuora-connector:get-workflows-by-workflow-id>
Retrieves information about a specific workflow by its ID. This operation makes an HTTP GET request to the /workflows/{workflow_id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Workflow id |
String |
The unique ID of a workflow. For example, 19080. |
x |
|
Authorization |
String |
|
x |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Export a workflow
<mule-zuora-connector:get-workflows-export-by-workflow-id>
Export a Workflow in a JSON document. This document can be used to create a copy of this workflow. This operation makes an HTTP GET request to the /workflows/{workflow_id}/export endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Workflow id |
Number |
The ID of the workflow to export. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get workflow task usage
<mule-zuora-connector:get-workflows-metricsjson>
Gets workflow task usage sorted by day within a specified time frame. This operation makes an HTTP GET request to the /workflows/metrics.json endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Start Date |
String |
The start date of the usage data that you want to get. For example, 2019-01-01. |
x |
|
End Date |
String |
The end date of the usage data that you want to get. For example, 2019-12-31. |
x |
|
metrics |
String |
The type of metric that you want to get. Currently, only |
x |
|
Authorization |
String |
|
x |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get tasks
<mule-zuora-connector:get-workflows-tasks>
Retrieves a list of workflow tasks available in your Zuora tenant. This operation makes an HTTP GET request to the /workflows/tasks endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
name |
String |
Retrieves tasks that are in the specified name |
||
Call type |
String |
Retrieves tasks with the specified API call type used |
||
tags |
String |
Retrieves tasks that have the specified filter tags |
||
page |
Number |
To retrieve only the workflows on a specific page, you can specify the |
1 |
|
instance |
Boolean |
If set to true, the operation retrieves workflows that have the scheduled trigger enabled. If set to false, the operation retrieves workflows that have the scheduled trigger disabled. If not specfied, the operation does not use this filter. |
false |
|
object |
String |
Retrieves tasks with the specified object |
||
id |
String |
Retrieves the task with the specified ID |
||
Workflow id |
String |
Retrieves tasks for the specified workflow ID |
||
Page length |
Number |
The number of workflows shown in a single call. If the |
20 |
|
Action type |
String |
Retrieves tasks with the specified type |
||
Object id |
String |
Retrieves tasks with the specified object ID |
||
Authorization |
String |
|
x |
|
Zuora Entity Ids |
String |
An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Get a task by ID
<mule-zuora-connector:get-workflows-tasks-by-task-id>
Retrieves a specific workflow task by its ID. This operation makes an HTTP GET request to the /workflows/tasks/{task_id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Task id |
String |
The unique ID of the task. |
x |
|
Authorization |
String |
|
x |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Update individual fields in a custom object record
<mule-zuora-connector:patch-objects-records-default-by-object-id>
Updates one or many fields of a custom object record. Patch update uses JSON Merge Patch as specified in RFC 7386.
Limitations
-
The storage of empty strings in records is not supported.
-
Null values must be formatted as the following example:
{ "records": [ { "fieldName__c": null } ] }
This operation makes an HTTP PATCH request to the /objects/records/default/{object}/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
object |
String |
Specifies the custom object''s API name as object. It is case-sensitive. |
x |
|
id |
String |
Id identifier in uuid form |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Authorization |
String |
|
x |
|
Zuora Version |
String |
API version that determines the response schema. The default version is used if this parameter is not included. Specify |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Update an Event Trigger
<mule-zuora-connector:update-events-event-triggers-by-id>
Updates an event trigger. This operation makes an HTTP PUT request to the /events/event-triggers/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
id |
x |
|
Authorization |
String |
|
x |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Update an email template
<mule-zuora-connector:update-notifications-email-templates-by-id>
Updates an email template. This operation makes an HTTP PUT request to the /notifications/email-templates/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The ID of the email template to be updated. |
x |
|
Authorization |
String |
|
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Update a notification definition
<mule-zuora-connector:update-notifications-notification-definitions-by-id>
Updates a notification definition. This operation makes an HTTP PUT request to the /notifications/notification-definitions/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The ID of the notification definition to be updated. |
x |
|
Authorization |
String |
|
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Update custom object record
<mule-zuora-connector:update-objects-records-default-by-object-id>
Update a record of the given type and id. ## Limitations * The storage of empty strings in records is not supported. * Null values must be formatted as the following example: { "records": [ { "fieldName__c": null } ] } This operation makes an HTTP PUT request to the /objects/records/default/{object}/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
object |
String |
Specifies the custom object''s API name as object. It is case-sensitive. |
x |
|
id |
String |
Id identifier in uuid form |
x |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Authorization |
String |
|
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Version |
String |
API version that determines the response schema. The default version is used if this parameter is not included. Specify |
||
If Match |
String |
The expected ETag of the resource. You can use this header to perform a conditional request. Zuora responds with 412 Precondition Failed if the ETag of the resource does not match the value of this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Activate accounting code
<mule-zuora-connector:update-v1-accounting-codes-activate-by-ac-id>
This reference describes how to activate an accounting code through the REST API. Prerequisites ------------- If you have Zuora Finance enabled on your tenant, you must have the Manage Accounting Code permission. This operation makes an HTTP PUT request to the /v1/accounting-codes/{ac-id}/activate endpoint
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 activate. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Update an accounting code
<mule-zuora-connector:update-v1-accounting-codes-by-ac-id>
This reference describes how to update an existing accounting code through the REST API. Prerequisites If you have Zuora Finance enabled on your tenant, you must have the Manage Accounting Code permission. Limitations You can only update accounting codes that are not already associated with any transactions. This operation makes an HTTP PUT request to the /v1/accounting-codes/{ac-id} endpoint
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 Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Deactivate accounting code
<mule-zuora-connector:update-v1-accounting-codes-deactivate-by-ac-id>
This reference describes how to deactivate an accounting code through the REST API.
Before You Begin
If you have Zuora Finance enabled on your tenant, you must have the Manage Accounting Code permission.
Limitations
You can only deactivate accounting codes that are not associated with any transactions. You cannot disable accounting codes of type AccountsReceivable.
This operation makes an HTTP PUT request to the /v1/accounting-codes/{ac-id}/deactivate endpoint.
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 deactivate. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Update accounting period
<mule-zuora-connector:update-v1-accounting-periods-by-ap-id>
Updates an accounting period. This operation makes an HTTP PUT request to the /v1/accounting-periods/{ap-id} endpoint.
Before You Begin
-
You must have Zuora Finance enabled on your tenant.
-
You must have the Create Accounting Period user permission. See [Finance Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/f_Finance_Roles).
Limitations
-
You can update the start date of only the earliest accounting period on your tenant.
-
You cannot update the start date of later periods. * If you update the earliest accounting period, the start date must be equal to or earlier than the date of the earliest transaction on the tenant.
-
Start and end dates of accounting periods must be contiguous. For example, if one accounting period ends on January 31, the next period must start on February 1.
-
If you have the Revenue Recognition Package and have enabled the "Monthly recognition over time" revenue recognition model, the accounting period start date and end date must be on the first day and last day of the month, respectively. Note that the start and end dates do not necessarily have to be in the same month.
-
You cannot update the start date or end date of an accounting period if:
-
Any revenue has been distributed into the period.
-
The period has any active journal entries.
-
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 update. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Close accounting period
<mule-zuora-connector:update-v1-accounting-periods-close-by-ap-id>
Close an accounting period by accounting period ID. This operation makes an HTTP PUT request to the /v1/accounting-periods/{ap-id}/close endpoint
Before You Begin
-
You must have Zuora Finance enabled on your tenant.
-
You must have the Manage Close Process and Run Trial Balance user permissions.
Limitations
-
The accounting period cannot already be closed.
-
The accounting period cannot be in the process of running a trial balance.
-
All earlier accounting periods must be closed.
-
There must be no required action items for the accounting period. See Reconcile Transactions Before Closing an Accounting Period for more information.
Notes
When you close an accounting period in Zuora, a trial balance is automatically run for that period. A successful response means only that the accounting period is now closed, but does not mean that the trial balance has successfully completed.
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 close. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Set accounting period to pending close
<mule-zuora-connector:update-v1-accounting-periods-pending-close-by-ap-id>
Sets an accounting period to pending close. This operation makes an HTTP PUT request to the /v1/accounting-periods/{ap-id}/pending-close endpoint
Before You Begin
-
You must have Zuora Finance enabled on your tenant.
-
You must have the Manage Close Process and Run Trial Balance user permissions.
Limitations
-
The accounting period cannot be closed or pending close.
-
The accounting period cannot be in the process of running a trial balance.
-
All earlier accounting periods must be closed.
Notes
When you set an accounting period to pending close in Zuora, a trial balance is automatically run for that period. A response of { "success": true } means only that the accounting period status is now pending close, but does not mean that the trial balance has successfully completed.
You can use the Get Accounting Period REST API call to view details about the outcome of the trial balance.
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 set to pending close. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Re-open accounting period
<mule-zuora-connector:update-v1-accounting-periods-reopen-by-ap-id>
Reopens an accounting period. This operation makes an HTTP PUT request to the /v1/accounting-periods/{ap-id}/reopen endpoint.
Before You Begin
-
You must have Zuora Finance enabled on your tenant.
-
You must have the Manage Close Process and Run Trial Balance user permissions.
Limitations
-
The accounting period must be closed or pending close.
-
You can only re-open an accounting period that is immediately previous to an open 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 that you want to re-open. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Run Trial Balance
<mule-zuora-connector:update-v1-accounting-periods-run-trial-balance-by-ap-id>
Runs the trial balance for an accounting period. This operation makes an HTTP PUT request to the /v1/accounting-periods/{ap-id}/run-trial-balance endpoint
Before You Begin
-
You must have Zuora Finance enabled on your tenant.
-
You must have the Manage Close Process and Run Trial Balance user permissions. See [Finance Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/f_Finance_Roles).
Limitations
-
The accounting period must be open.
-
The accounting period cannot already be in the process of running a trial balance.
Notes
The trial balance is run asynchronously. A response of { "success": true } means only that the trial balance has started processing, but does not mean that the trial balance has successfully completed.
You can use the [Get Accounting Period](https://www.zuora.com/developer/api-reference/#operation/GET_AccountingPeriod) REST API call to view details about the outcome of the trial balance.
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 for which you want to run a trial balance. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Update account
<mule-zuora-connector:update-v1-accounts-by-account-key>
Updates a customer account by specifying the account-key.
Notes
-
Only the fields to be changed should be specified. Any field that is not included in the request body will not be changed.
-
If an empty field is submitted with this operation, the corresponding field in the account is emptied.
-
Email addresses: If no email addresses are specified, no change is made to the email addresses on file or to the email delivery preference. If either the personalEmail or workEmail is specified (or both), the system updates the corresponding email address(es) on file and the email delivery preference is set to
true. (In that case, emails go to the workEmail address, if it exists, or else the personalEmail.)
On the other hand, if as a result of this call both of the email addresses for the account are empty, the email delivery preference is set tofalse. -
The bill-to and sold-to contacts are separate data entities; updating either one does not update the other. This operation makes an HTTP PUT request to the /v1/accounts/{account-key} endpoint
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 Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Edit Attachments
<mule-zuora-connector:update-v1-attachments-by-attachment-id>
Use the Edit Attachment REST request to make changes to the descriptive fields of an attachment, such as the description and the file name.
You cannot change the actual content of the attached file in Zuora. If you need to change the actual content, you need to delete the attachment and add the updated file as a new attachment.
This operation makes an HTTP PUT request to the /v1/attachments/{attachment-id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Attachment id |
String |
Id of the attachment to be updated. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Stop Mass Action
<mule-zuora-connector:update-v1-bulk-stop-by-bulk-key>
This reference describes how to stop a mass action through the REST API.
You can stop a mass action when its status is Pending or Processing. After you have stopped a mass action, you can get the mass action result to see details of the mass action.
-
If you stop a mass action when its status is Pending, no response file is generated because no records have been processed.
-
If you stop a mass action when its status is Processing, a response file is generated.
You can check the response file to see which records have been processed and which have not. In the response file, the Success column has the value Y (successful) or N (failed) for processed records, and a blank value for unprocessed records. Records that have already been processed when a mass action is stopped are not rolled back.
This operation makes an HTTP PUT request to the /v1/bulk/{bulk-key}/stop endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Bulk key |
String |
String of 32 characters that identifies a mass action. You get the bulk-key after performing a mass action through the REST API. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Scrub Contact
<mule-zuora-connector:update-v1-contacts-scrub-by-contact-id>
Scrubs the sensitive data of a specific contact.
You can use this operation to replace all sensitive data in a contact and its related contact snapshot with dummy values that will be stored in Zuora databases. After scrubbing a contact, it is good practice to delete it. Otherwise, it might cause errors in subsequent operations.
Note: To use this operation, you must ensure that the "Scrub Sensitive Data of Contact" billing permission is enabled in your user role. Contact your tenant administrator if you want to enable this permission. See [Scrub Contacts](https://knowledgecenter.zuora.com/BC_Subscription_Management/Customer_Accounts/A_How_to_Manage_Customer_Accounts/B_Key_Contacts/Scrub_Contacts) for more information.
This operation makes an HTTP PUT request to the /v1/contacts/{contactId}/scrub endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Contact Id |
String |
The ID of the contact that you want to scrub sensitive data from. |
x |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Apply Credit Memo
<mule-zuora-connector:update-v1-creditmemos-apply-by-credit-memo-id>
Note: The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/). Applies a posted credit memo to one or more invoices and debit memos.
You can apply a credit memo to an invoice or a debit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. When applying a credit memo, the total number of invoices and debit memos that the credit memo will apply to must be less than or equal to 1,000. If the Proration application rule is used, when applying credit memos, the following quantity must be less than or equal to 10,000: (number of invoice items + number of debit memo items) * number of credit memo items Otherwise, the First In First Out rule will be used instead of the Proration rule.
This operation makes an HTTP PUT request to the /v1/creditmemos/{creditMemoId}/apply endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Credit Memo Id |
String |
The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Update Credit Memo
<mule-zuora-connector:update-v1-creditmemos-by-credit-memo-id>
Note: The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/). Updates the basic and finance information about a credit memo. Currently, Zuora supports updating tax-exclusive memo items, but does not support updating tax-inclusive memo items.
If the amount of a memo item is updated, the tax will be recalculated in the following conditions:
-
The memo is created from a product rate plan charge and you use Avalara to calculate the tax. * The memo is created from an invoice and you use Avalara or Zuora Tax to calculate the tax.
You can update a credit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.
This operation makes an HTTP PUT request to the /v1/creditmemos/{creditMemoId} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Credit Memo Id |
String |
The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Cancel Credit Memo
<mule-zuora-connector:update-v1-creditmemos-cancel-by-credit-memo-id>
The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support.
Cancels a credit memo. Only credit memos with the Draft status can be cancelled.
You can cancel a credit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.
This operation makes an HTTP PUT request to the /v1/creditmemos/{creditMemoId}/cancel endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Credit Memo Id |
String |
The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Post credit memo
<mule-zuora-connector:update-v1-creditmemos-post-by-credit-memo-id>
Note: The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support.
Posts a credit memo to activate it.
You can post credit memos only if you have the Billing permissions.
This operation makes an HTTP PUT request to the /v1/creditmemos/{creditMemoId}/post endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Credit Memo Id |
String |
The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Unapply credit memo
<mule-zuora-connector:update-v1-creditmemos-unapply-by-credit-memo-id>
Note: The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support. Unapplies an applied credit memo from one or more invoices and debit memos. The full applied amount from invoices and debit memos is transferred into the unapplied amount of the credit memo. You can unapply a credit memo from an invoice or a debit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. When unapplying a credit memo, the total number of invoices and debit memos that the credit memo will be unapplied from must be less than or equal to 1,000. If the Proration application rule is used, when unapplying credit memos, the following quantity must be less than or equal to 10,000: (number of invoice items + number of debit memo items) * number of credit memo items Otherwise, the First In First Out rule will be used instead of the Proration rule. This operation makes an HTTP PUT request to the /v1/creditmemos/{creditMemoId}/unapply endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Credit Memo Id |
String |
The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Unpost credit memo
<mule-zuora-connector:update-v1-creditmemos-unpost-by-credit-memo-id>
Note: The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support. Unposts a credit memo that is in Posted status. If a credit memo has been applied or refunded, you are not allowed to unpost it. After a credit memo is unposted, its status becomes Draft. You can unpost credit memos only if you have the [Billing permissions](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles#Billing_Permissions). This operation makes an HTTP PUT request to the /v1/creditmemos/{creditMemoId}/unpost endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Credit Memo Id |
String |
The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
PUT Batch Update Debit Memos
<mule-zuora-connector:update-v1-debitmemos>
Note: The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support. Updates the due date for multiple debit memos in batches with one call. This operation makes an HTTP PUT request to the /v1/debitmemos endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Update debit memo
<mule-zuora-connector:update-v1-debitmemos-by-debit-memo-id>
Note: The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support. Updates the basic and finance information about a debit memo. Currently, Zuora supports updating tax-exclusive memo items, but does not support updating tax-inclusive memo items. If the amount of a memo item is updated, the tax will be recalculated in the following conditions: - The memo is created from a product rate plan charge and you use Avalara to calculate the tax. - The memo is created from an invoice and you use Avalara or Zuora Tax to calculate the tax. You can update a debit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. This operation makes an HTTP PUT request to the /v1/debitmemos/{debitMemoId} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Debit Memo Id |
String |
The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Cancel debit memo
<mule-zuora-connector:update-v1-debitmemos-cancel-by-debit-memo-id>
Note: The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support. Cancels a debit memo. Only debit memos with the Draft status can be cancelled. You can cancel a debit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. This operation makes an HTTP PUT request to the /v1/debitmemos/{debitMemoId}/cancel endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Debit Memo Id |
String |
The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Post debit memo
<mule-zuora-connector:update-v1-debitmemos-post-by-debit-memo-id>
Note: The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support. Posts a debit memo to activate it. You can post debit memos only if you have the [Billing permissions](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles#Billing_Permissions). This operation makes an HTTP PUT request to the /v1/debitmemos/{debitMemoId}/post endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Debit Memo Id |
String |
The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Unpost debit memo
<mule-zuora-connector:update-v1-debitmemos-unpost-by-debit-memo-id>
Note: The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support. Unposts a debit memo that is in Posted status. If any credit memo or payment has been applied to a debit memo, you are not allowed to unpost the debit memo. After a debit memo is unposted, its status becomes Draft. You can unpost debit memos only if you have the [Billing permissions](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles#Billing_Permissions). This operation makes an HTTP PUT request to the /v1/debitmemos/{debitMemoId}/unpost endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Debit Memo Id |
String |
The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Update document properties
<mule-zuora-connector:update-v1-document-properties-by-document-properties-id>
Note: This feature is available only if you have the Billing Document Properties Setup feature enabled. The Billing Document Properties Setup feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support. Updates document properties with a specific ID for a billing document. Billing documents include invoices, credit memos, and debit memos. Note: You can update document properties for credit and debit memos only if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support. This operation makes an HTTP PUT request to the /v1/document-properties/{documentPropertiesId} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Document Properties Id |
String |
The unique ID of document properties to be updated. For example, 402892c74c9193cd014c96bbe7c101f9. |
x |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Multi-entity: Update entity
<mule-zuora-connector:update-v1-entities-by-id>
Note: The Multi-entity feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support.
Edits the following information about an unprovisioned entity:
-
Name
-
Display name *Locale
-
Timezone
Notes
-
You cannot edit the locale and time zone of the provisioned entities through the REST API.
-
You cannot edit the display name of the global entity.
This operation makes an HTTP PUT request to the /v1/entities/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The Id of the entity that you want to edit. You can get the entity Id from the GET Entities call. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Multi-entity: Provision entity
<mule-zuora-connector:update-v1-entities-provision-by-id>
This object provisions an entity.
Note: The Multi-entity feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support.
You can only provision an entity if its parent entity is provisioned.
Notes
Zuora does not allow you to remove a provisioned entity from the multi-entity hierarchy. So before you provision an entity, make sure that you put the entity in the correct place in the multi-entity hierarchy.
This operation makes an HTTP PUT request to the /v1/entities/{id}/provision endpoint
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 provision. You can get the entity Id from the GET Entities call. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Multi-entity: Accept connection
<mule-zuora-connector:update-v1-entity-connections-accept-by-connection-id>
This operation accepts a connection request. This operation makes an HTTP PUT request to the /v1/entity-connections/{connection-id}/accept endpoint.
Note: The Multi-entity feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support.
User Access Permission
You must make the call as an entity administrator to accept a connection request.
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 Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Multi-entity: Deny connection
<mule-zuora-connector:update-v1-entity-connections-deny-by-connection-id>
This operation denies a connection request. This operation makes an HTTP PUT request to the /v1/entity-connections/{connection-id}/deny endpoint.
Note: The Multi-entity feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support.
User Access Permission
You must make the call as an entity administrator to deny a connection request.
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 deny. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Multi-entity: Disconnect connection
<mule-zuora-connector:update-v1-entity-connections-disconnect-by-connection-id>
This operation disconnects an established connection. This operation makes an HTTP PUT request to the /v1/entity-connections/{connection-id}/disconnect endpoint.
Note: The Multi-entity feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support.
Disconnects an established connection. If you have shared objects from a global entity to a target entity, disconnecting the connection will break the mapping relationship between these entities and cannot be recovered later.
User Access Permission
You must make the call as an administrator of the target entity or source 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 disconnect. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Update invoices
<mule-zuora-connector:update-v1-invoices>
Updates multiple invoices in batches with one call. This operation makes an HTTP PUT request to the /v1/invoices endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Update invoice
<mule-zuora-connector:update-v1-invoices-by-invoice-id>
Updates a specific invoice. This operation makes an HTTP PUT request to the /v1/invoices/{invoiceId} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Invoice Id |
String |
The ID of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Reverse invoice
<mule-zuora-connector:update-v1-invoices-reverse-by-invoice-id>
This operation reverses a posted invoice.
Note: This feature is only available if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support.
Restrictions
You are not allowed to reverse an invoice if one of the following restrictions is met:
-
Payments and credit memos are applied to the invoice.
-
The invoice is split.
-
The invoice is not in Posted status.
-
The total amount of the invoice is less than 0 (a negative invoice).
-
Using Tax Connector for Extension Platform to calculate taxes. See [Reverse Posted Invoices](https://knowledgecenter.zuora.com/CB_Billing/IA_Invoices/Reverse_Posted_Invoices) for more information. This operation makes an HTTP PUT request to the /v1/invoices/{invoiceId}/reverse endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Invoice Id |
String |
The ID of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Write off invoice
<mule-zuora-connector:update-v1-invoices-write-off-by-invoice-id>
This operation writes off a posted invoice. This operation makes an HTTP PUT request to the /v1/invoices/{invoiceId}/write-off endpoint.
Note: This feature is only available if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support.
When an invoice is written off, a credit memo is created and applied to the invoice. The generated credit memo items and credit memo taxation items are applied to invoice items and invoice taxation items based on the configured default application rule. If an invoice is written off, the balance of each invoice item and invoice taxation item must be zero. If you set the Create credit memos mirroring invoice items billing rule to Yes, you can write off an invoice even if all its items have zero balance.
Restrictions
You cannot write off an invoice if any of the following restrictions are in place:
-
The balance of an invoice has been changed before Invoice Settlement is enabled.
For example, before Invoice Settlement is enabled, any credit balance adjustments, invoice item adjustments, or invoice adjustments have been applied to an invoice. -
An invoice contains more than 750 items in total, including invoice items, discount items, and taxation items.
See Invoice Write-off for more information.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Invoice Id |
String |
The unique ID of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Update basic information of a summary journal entry
<mule-zuora-connector:update-v1-journal-entries-basic-information-by-je-number>
This REST API reference describes how to update the basic information of a summary journal entry. Request and response field descriptions and sample code are provided. This operation makes an HTTP PUT request to the /v1/journal-entries/{je-number}/basic-information endpoint
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 Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Cancel summary journal entry
<mule-zuora-connector:update-v1-journal-entries-cancel-by-je-number>
This reference describes how to cancel a summary journal entry using the REST API. You must have the "Cancel Journal Entry" user permission enabled to cancel summary journal entries. A summary journal entry cannot be canceled if its Transferred to Accounting status is "Yes" or "Processing". This operation makes an HTTP PUT request to the /v1/journal-entries/{je-number}/cancel endpoint
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 Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Cancel Journal Run
<mule-zuora-connector:update-v1-journal-runs-cancel-by-jr-number>
This reference describes how to cancel a journal run using the REST API. The summary journal entries in the journal run are canceled asynchronously. See the "Example" section below for details.
You must have the "Cancel Journal Run" Zuora Finance user permission enabled to cancel journal runs.
Notes
When you cancel a journal run, the summary journal entries associated with that journal run are canceled asynchronously. A response of { "success": true } means only that the specified journal run has a status of "Pending", "Error", or "Completed" and therefore can be canceled, but does not mean that the whole journal run was successfully canceled. For example, let’s say you want to cancel journal run JR-00000075. The journal run status is "Completed" and it contains ten journal entries. One of the journal entries has its Transferred to Accounting status set to "Yes", meaning that the entry cannot be canceled. The workflow might go as follows:
-
Make an API call to cancel the journal run.
-
The journal run status is "Completed", so you receive a response of
{ "success": true }. -
Zuora begins asynchronously canceling journal entries associated with the journal run. The journal entry whose Transferred to Accounting status is "Yes" fails to be canceled. The cancelation process continues, and the other journal entries are successfully canceled.
-
The journal run status remains as "Completed". The status does not change to "Canceled" because the journal run still contains a journey entry that is not canceled.
This operation makes an HTTP PUT request to the /v1/journal-runs/{jr-number}/cancel endpoint
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. You can only cancel a journal run whose status is "Pending", "Error", or "Completed". |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Update account
<mule-zuora-connector:update-v1-object-account-by-id>
Updates an account. This operation makes an HTTP PUT request to the /v1/object/account/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Update amendment
<mule-zuora-connector:update-v1-object-amendment-by-id>
CRUD: Update amendment This operation makes an HTTP PUT request to the /v1/object/amendment/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Post or Cancel bill run
<mule-zuora-connector:update-v1-object-bill-run-by-id>
Note: This feature is in Limited Availability. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com). Post a Bill Run Posting a bill run is an asynchronous operation. To post a bill run, the current bill run must have a status of Completed. When a bill run is posted, its status is changed to PostInProgress. Once all invoices for this bill run are posted then its status is changed to Posted. When you post a bill run and query the status of a bill run, you will get one of the following results PostInProgress, Completed, or Posted. If all invoices in the bill run are posted, then the status of the bill run is Posted. If one or more invoices fail to post, the status will change back to Completed and you will need to post the bill run again. Cancel a Bill Run Canceling a bill run is an asynchronous operation. When canceling a bill run, the logic is the same as when using the UI to cancel a bill run. You need to provide the BillRunId, and set the Status to Canceled. When canceling a bill run, consider the following: * Canceling a bill run with a Completed status. * Only the current bill run will be canceled. * Canceling a bill run with a Pending status. * When canceling an Ad-hoc bill run, only the current bill run will be canceled. * When canceling a scheduled bill, all scheduled bill runs will be canceled. The Cancel operation may not be successful. Its success depends on its current business validation. Only a bill run that has no posted invoices can be canceled. If any posted invoices belong to the bill run then an invalid value exception will be thrown with the message, "The Bill Run cannot be Cancelled, There are Posted invoices." This operation makes an HTTP PUT request to the /v1/object/bill-run/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Update contact
<mule-zuora-connector:update-v1-object-contact-by-id>
Updates a contact for a specified account. You can update contacts for cancelled accounts. This operation makes an HTTP PUT request to the /v1/object/contact/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Update CreditBalanceAdjustment
<mule-zuora-connector:update-v1-object-credit-balance-adjustment-by-id>
This CRUD operation makes an HTTP PUT request to the /v1/object/credit-balance-adjustment/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. If |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Object PUTFeature
<mule-zuora-connector:update-v1-object-feature-by-id>
Object PUTFeature This operation makes an HTTP PUT request to the /v1/object/feature/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Update InvoiceAdjustment
<mule-zuora-connector:update-v1-object-invoice-adjustment-by-id>
CRUD: Update InvoiceAdjustment This operation makes an HTTP PUT request to the /v1/object/invoice-adjustment/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Update invoice
<mule-zuora-connector:update-v1-object-invoice-by-id>
CRUD: Update invoice This operation makes an HTTP PUT request to the /v1/object/invoice/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Update InvoicePayment
<mule-zuora-connector:update-v1-object-invoice-payment-by-id>
CRUD: Update InvoicePayment This operation makes an HTTP PUT request to the /v1/object/invoice-payment/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Update payment
<mule-zuora-connector:update-v1-object-payment-by-id>
Updates a payment. This operation makes an HTTP PUT request to the /v1/object/payment/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The unique ID of a payment. For example, 2c92c095592623ea01596621ada84352. |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Update payment method
<mule-zuora-connector:update-v1-object-payment-method-by-id>
CRUD: Update payment method This operation makes an HTTP PUT request to the /v1/object/payment-method/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Update Product
<mule-zuora-connector:update-v1-object-product-by-id>
CRUD: Update Product This operation makes an HTTP PUT request to the /v1/object/product/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Update ProductRatePlan
<mule-zuora-connector:update-v1-object-product-rate-plan-by-id>
CRUD: Update ProductRatePlan This operation makes an HTTP PUT request to the /v1/object/product-rate-plan/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Update product rate plan charge
<mule-zuora-connector:update-v1-object-product-rate-plan-charge-by-id>
Updates the information about a product rate plan charge. This operation makes an HTTP PUT request to the /v1/object/product-rate-plan-charge/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The unique ID of the product rate plan charge to be updated. For example, 2c93808457d787030157e031fcd34e19. |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Update ProductRatePlanChargeTier
<mule-zuora-connector:update-v1-object-product-rate-plan-charge-tier-by-id>
Updates the price of a product rate plan charge tier. To make other updates to product rate plan charge tiers, use [CRUD: Update product rate plan charge](https://www.zuora.com/developer/api-reference/#operation/Object_PUTProductRatePlanCharge) and specify ProductRatePlanChargeTierData in the request body. This operation makes an HTTP PUT request to the /v1/object/product-rate-plan-charge-tier/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The unique ID of the product rate plan charge tier to be updated. For example, 2c92c0f86c85891e016c88d55a6e543b. |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Update rate plan charge
<mule-zuora-connector:update-v1-object-rate-plan-charge-by-id>
CRUD: Update rate plan charge This operation makes an HTTP PUT request to the /v1/object/rate-plan-charge/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Update refund
<mule-zuora-connector:update-v1-object-refund-by-id>
CRUD: Update refund This operation makes an HTTP PUT request to the /v1/object/refund/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Update Subscription
<mule-zuora-connector:update-v1-object-subscription-by-id>
CRUD: Update Subscription This operation makes an HTTP PUT request to the /v1/object/subscription/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Update TaxationItem
<mule-zuora-connector:update-v1-object-taxation-item-by-id>
CRUD: Update TaxationItem This operation makes an HTTP PUT request to the /v1/object/taxation-item/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Update UnitOfMeasure
<mule-zuora-connector:update-v1-object-unit-of-measure-by-id>
CRUD: Update UnitOfMeasure This operation makes an HTTP PUT request to the /v1/object/unit-of-measure/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
CRUD: Update usage
<mule-zuora-connector:update-v1-object-usage-by-id>
CRUD: Update usage This operation makes an HTTP PUT request to the /v1/object/usage/{id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
Object id |
x |
|
Reject Unknown Fields |
Boolean |
Specifies whether the call fails if the request body contains unknown fields. With |
false |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Update order custom fields
<mule-zuora-connector:update-v1-orders-custom-fields-by-order-number>
Note: This feature is only available if you have the [Order Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) feature enabled. The migration to Order Metrics is in Limited Availability. We are actively soliciting feedback from a small set of early adopters before releasing as generally available. If you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders) feature enabled, you already have the Order Metrics feature enabled. Updates the custom fields of a specified order. This operation makes an HTTP PUT request to the /v1/orders/{orderNumber}/customFields endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Order Number |
String |
The order number. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Update order action trigger dates
<mule-zuora-connector:update-v1-orders-trigger-dates-by-order-number>
Note: This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature enabled. The migration to Orders is in Limited Availability. We are actively soliciting feedback from a small set of early adopters before releasing as generally available. Updates the triggering dates for either of the following order actions: * CreateSubscription * AddProduct * UpdateProduct * RemoveProduct * RenewSubscription * TermsAndConditions This operation makes an HTTP PUT request to the /v1/orders/{orderNumber}/triggerDates endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Order Number |
String |
Order number of a pending order in which you are to update an order action''s triggering dates. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Update credit card payment method
<mule-zuora-connector:update-v1-payment-methods-credit-cards-by-payment-method-id>
Updates an existing credit card payment method for the specified customer account. This operation makes an HTTP PUT request to the /v1/payment-methods/credit-cards/{payment-method-id} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Payment method id |
String |
Unique ID of the payment method to update. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Scrub payment method
<mule-zuora-connector:update-v1-payment-methods-scrub-by-payment-method-id>
This operation enables you to replace all sensitive data in a payment method, related payment method snapshot table, and four related log tables with dummy values that will be stored in Zuora databases. This operation will scrub the sensitive data and soft-delete the specified payment method at the same time. If you want to delete or anonymize personal data in Zuora, you must scrub the payment method before anonymizing the associated account and contact. See [Delete or anonymize personal data](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Responding_to_individual_requests_for_access%2C_correction%2C_and_deletion_of_data_under_applicable_privacy_laws#Edit_and_correct_personal_data) for more information. Note: In order to use this operation, you must ensure that the Scrub Sensitive Data of Specific Payment Method payments permission is enabled in your user role. Contact your tenant administrator if you want to enable this permission. See [Scrub Payment Methods](https://knowledgecenter.zuora.com/CB_Billing/L_Payment_Methods/Scrub_Payment_Methods) for more information. This operation makes an HTTP PUT request to the /v1/payment-methods/{payment-method-id}/scrub endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Payment method id |
String |
The ID of the payment method where you want to scrub the sensitive data. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Verify payment method
<mule-zuora-connector:update-v1-payment-methods-verify-by-payment-method-id>
Sends an authorization request to the corresponding payment gateway to verify the payment method, even though no changes are made for the payment method. Supported payment methods are Credit Cards and Paypal. Zuora now supports performing a standalone zero dollar verification or one dollar authorization for credit cards. It also supports a billing agreement status check on PayPal payment methods. If a payment method is created by Hosted Payment Pages and is not assigned to any billing account, the payment method cannot be verified through this operation. This operation makes an HTTP PUT request to the /v1/payment-methods/{payment-method-id}/verify endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Payment method id |
String |
The ID of the payment method to be verified. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Update payment run
<mule-zuora-connector:update-v1-payment-runs-by-payment-run-id>
Updates the information about an unexecuted payment run. Only pending payment runs can be updated. If none of the accountId, batch, billCycleDay, currency, paymentGatewayId, and billingRunId fields is specified in the request body, the corresponding payment run collects payments for all accounts. This operation makes an HTTP PUT request to the /v1/payment-runs/{paymentRunId} endpoint
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 |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Apply payment
<mule-zuora-connector:update-v1-payments-apply-by-payment-id>
Note: The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support. Applies an unapplied payment to invoices and debit memos. When applying a payment, the total number of invoices and debit memos that the payment will apply to must be less than or equal to 1,000. If the Proration application rule is used, when applying a payment, the following quantity must be less than or equal to 10,000: (number of invoice items + number of debit memo items) * number of payment items Otherwise, the First In First Out rule will be used instead of the Proration rule. For more information, see [Apply Unapplied Payments to Invoices and Debit Memos](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/A_Unapplied_Payments/Management_of_Unapplied_Payments/Apply_Unapplied_Payments_to_Invoices_and_Debit_Memos). This operation makes an HTTP PUT request to the /v1/payments/{paymentId}/apply endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Payment Id |
String |
The unique ID of an unapplied payment. For example, 8a8082e65b27f6c3015b89e4344c16b1. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Update payment
<mule-zuora-connector:update-v1-payments-by-payment-id>
Note: The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support. Updates a payment. This operation makes an HTTP PUT request to the /v1/payments/{paymentId} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Payment Id |
String |
The unique ID of an unapplied payment. For example, 8a8082e65b27f6c3015b89e4344c16b1. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Cancel payment
<mule-zuora-connector:update-v1-payments-cancel-by-payment-id>
Note: The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support. Cancels a payment. If you have the Invoice Settlement feature enabled, overpayments applied to credit balance cannot be cancelled. This operation makes an HTTP PUT request to the /v1/payments/{paymentId}/cancel endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Payment Id |
String |
The unique ID of an unapplied payment. For example, 8a8082e65b27f6c3015b89e4344c16b1. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Transfer payment
<mule-zuora-connector:update-v1-payments-transfer-by-payment-id>
Note: The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support. Transfers an unapplied payment. For more information, see [Transfer Unapplied Payments](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/A_Unapplied_Payments/Management_of_Unapplied_Payments/Transfer_Unapplied_Payments). This operation makes an HTTP PUT request to the /v1/payments/{paymentId}/transfer endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Payment Id |
String |
The unique ID of an unapplied payment. For example, 8a8082e65b27f6c3015b89e4344c16b1. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Unapply payment
<mule-zuora-connector:update-v1-payments-unapply-by-payment-id>
Note: The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request at Zuora Global Support. Unapplies an applied payment from invoices and debit memos. For more information, see [Unapply Payments from Invoices and Debit Memos](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/A_Unapplied_Payments/Management_of_Unapplied_Payments/Unapply_Payments_from_Invoices_and_Debit_Memos). This operation makes an HTTP PUT request to the /v1/payments/{paymentId}/unapply endpoint
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 applied payment. For example, 8a8082e65b27f6c3015b89e4344c16b1. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Update refund
<mule-zuora-connector:update-v1-refunds-by-refund-id>
Note: This feature is only available if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support. Updates the basic and finance information about a refund. This operation makes an HTTP PUT request to the /v1/refunds/{refundId} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Refund Id |
String |
The unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Cancel refund
<mule-zuora-connector:update-v1-refunds-cancel-by-refund-id>
Note: This feature is only available if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support. Cancels a refund. If you have the Invoice Settlement feature enabled, refunds applied to credit balance cannot be cancelled. This operation makes an HTTP PUT request to the /v1/refunds/{refundId}/cancel endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Refund Id |
String |
The unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Update custom fields on revenue items by revenue event number
<mule-zuora-connector:update-v1-revenue-items-revenue-events-by-event-number>
This REST API reference describes how to update custom fields on revenue items by specifying the revenue event number. Request and response field descriptions and sample code are provided. This operation makes an HTTP PUT request to the /v1/revenue-items/revenue-events/{event-number} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Event number |
String |
The number associated with the revenue event. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Update custom fields on revenue items by revenue schedule number
<mule-zuora-connector:update-v1-revenue-items-revenue-schedules-by-rs-number>
This REST API reference describes how to update custom fields on revenue Items by specifying the revenue schedule number. Request and response field descriptions and sample code are provided. This operation makes an HTTP PUT request to the /v1/revenue-items/revenue-schedules/{rs-number} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Rs number |
String |
Revenue schedule number. The revenue schedule number is always prefixed with "RS", for example, "RS-00000001". |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Update revenue schedule basic information
<mule-zuora-connector:update-v1-revenue-schedules-basic-information-by-rs-number>
Retrieves basic information of a revenue schedule by specifying the revenue schedule number. Request and response field descriptions and sample code are provided. This operation makes an HTTP PUT request to the /v1/revenue-schedules/{rs-number}/basic-information endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Rs number |
String |
Revenue schedule number. The revenue schedule number is always prefixed with "RS", for example, "RS-00000001". |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Distribute revenue across accounting periods
<mule-zuora-connector:update-v1-revenue-schedules-distribute-revenue-across-accounting-periods-by-rs-number>
Distributes revenue by specifying the revenue schedule number. Request and response field descriptions and sample code are provided. This operation makes an HTTP PUT request to the /v1/revenue-schedules/{rs-number}/distribute-revenue-across-accounting-periods endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Rs number |
String |
Revenue schedule number. The revenue schedule number is always prefixed with "RS", for example, "RS-00000001". |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Distribute revenue on specific date
<mule-zuora-connector:update-v1-revenue-schedules-distribute-revenue-on-specific-date-by-rs-number>
Distributes revenue on a specific recognition date. Request and response field descriptions and sample code are provided.
This operation makes an HTTP PUT request to the /v1/revenue-schedules/{rs-number}/distribute-revenue-on-specific-date endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Rs number |
String |
Revenue schedule number. The revenue schedule number is always prefixed with "RS", for example, "RS-00000001". |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Distribute revenue by recognition start and end dates
<mule-zuora-connector:update-v1-revenue-schedules-distribute-revenue-with-date-range-by-rs-number>
Distributes revenue by specifying the recognition start and end dates. Request and response field descriptions and sample code are provided. This operation makes an HTTP PUT request to the /v1/revenue-schedules/{rs-number}/distribute-revenue-with-date-range endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Rs number |
String |
Revenue schedule number. Specify the revenue schedule whose revenue you want to distribute. The revenue schedule number is always prefixed with "RS", for example, "RS-00000001". |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
PUT Rev Pro Accounting Codes
<mule-zuora-connector:update-v1-revpro-accounting-codes>
Update the Zuora Revenue accounting code that corresponds to a specific Product Rate Plan Charge Id in Zuora Billing. This operation makes an HTTP PUT request to the /v1/revpro-accounting-codes endpoint
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](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Authorization |
String |
|
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Update Sequence Set
<mule-zuora-connector:update-v1-sequence-sets-by-id>
Updates a specific sequence set configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos.
| The Credit and Debit Memos feature is available only if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support. |
This operation makes an HTTP PUT request to the /v1/sequence-sets/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The ID of the sequence set to update. |
x |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Update subscription
<mule-zuora-connector:update-v1-subscriptions-by-subscription-key>
Use this call to make the following kinds of changes to a subscription: * Add a note * Change the renewal term or auto-renewal flag * Change the term length or change between evergreen and termed * Add a new product rate plan * Remove an existing subscription rate plan * Change the quantity or price of an existing subscription rate plan Notes * The Update Subscription call creates a new subscription, which has the old subscription number but a new subscription ID. The old subscription is canceled but remains in the system. * In one request, this call can make: * Up to 9 combined add, update, and remove changes * No more than 1 change to terms & conditions * Updates are performed in the following sequence: 1. First change the notes on the existing subscription, if requested. 2. Then change the terms and conditions, if requested. 3. Then perform the remaining amendments based upon the effective dates specified. If multiple amendments have the same contract-effective dates, then execute adds before updates, and updates before removes. * The update operation is atomic. If any of the updates fails, the entire operation is rolled back. * The response of the Update Subscription call is based on the REST API minor version you set in the request header. The response structure might be different if you use different minor version numbers. * If you have the Invoice Settlement feature enabled, it is best practice to set the zuora-version parameter to 211.0 or later. Otherwise, an error occurs. Override a Tiered Price There are two ways you override a tiered price: * Override a specific tier number For example: tiers[{tier:1,price:8},{tier:2,price:6}] * Override the entire tier structure For example: tiers[{tier:1,price:8,startingUnit:1,endingUnit:100,priceFormat:"FlatFee"}, {tier:2,price:6,startingUnit:101,priceFormat:"FlatFee"}] If you just override a specific tier, do not include the startingUnit field in the request. This operation makes an HTTP PUT request to the /v1/subscriptions/{subscription-key} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Subscription key |
String |
Subscription number or ID. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora version |
String |
The minor version of the Zuora REST API. You need to set this parameter if you use the following fields: * collect * invoice * includeExistingDraftDocItems * previewType * runBilling * targetDate If you have the Invoice Settlement feature enabled, you need to specify this parameter. Otherwise, an error is returned. See [Zuora REST API Versions](https://www.zuora.com/developer/api-reference/#section/API-Versions) for more information. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Cancel Subscription
<mule-zuora-connector:update-v1-subscriptions-cancel-by-subscription-key>
This REST API reference describes how to cancel an active subscription. Note: If you have the Invoice Settlement feature enabled, it is best practice to set the zuora-version parameter to 211.0 or later. Otherwise, an error occurs. This operation makes an HTTP PUT request to the /v1/subscriptions/{subscription-key}/cancel endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Subscription key |
String |
Subscription number or ID. Subscription status must be |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora 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 |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Update Subscription Custom Fields
<mule-zuora-connector:update-v1-subscriptions-custom-fields-by-subscription-number>
Note: This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature enabled. The migration to Orders is in Limited Availability. We are actively soliciting feedback from a small set of early adopters before releasing as generally available. Updates the custom fields of a specified subscription. This operation makes an HTTP PUT request to the /v1/subscriptions/{subscriptionNumber}/customFields endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Subscription Number |
String |
The subscription number to be updated. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Renew subscription
<mule-zuora-connector:update-v1-subscriptions-renew-by-subscription-key>
Renews a termed subscription using existing renewal terms. Note: If you have the Invoice Settlement feature enabled, it is best practice to set the zuora-version parameter to 211.0 or later. Otherwise, an error occurs. This operation makes an HTTP PUT request to the /v1/subscriptions/{subscription-key}/renew endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Subscription key |
String |
Subscription number or ID |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora 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 |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Resume Subscription
<mule-zuora-connector:update-v1-subscriptions-resume-by-subscription-key>
This REST API reference describes how to resume a suspended subscription. Note: If you have the Invoice Settlement feature enabled, it is best practice to set the zuora-version parameter to 211.0 or later. Otherwise, an error occurs.
This operation makes an HTTP PUT request to the /v1/subscriptions/{subscription-key}/resume endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Subscription key |
String |
Subscription number or ID. Subscription status must be Active. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora 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 |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Suspend subscription
<mule-zuora-connector:update-v1-subscriptions-suspend-by-subscription-key>
This REST API reference describes how to suspend an active subscription. Note: If you have the Invoice Settlement feature enabled, it is best practice to set the zuora-version parameter to 211.0 or later. Otherwise, an error occurs. This operation makes an HTTP PUT request to the /v1/subscriptions/{subscription-key}/suspend endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Subscription key |
String |
Subscription number or ID. Subscription status must be Active. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora 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 |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Update subscription custom fields of a specified subscription version
<mule-zuora-connector:update-v1-subscriptions-versions-custom-fields-by-subscription-number-version>
Updates the custom fields of a specified subscription version. This operation makes an HTTP PUT request to the /v1/subscriptions/{subscriptionNumber}/versions/{version}/customFields endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Subscription Number |
String |
The subscription number to be updated. |
x |
|
version |
String |
The subscription version to be updated. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Update taxation item
<mule-zuora-connector:update-v1-taxationitems-by-id>
Updates a specific taxation item by ID. This operation makes an HTTP PUT request to the /v1/taxationitems/{id} endpoint
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 Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Multi-entity: Accept user access
<mule-zuora-connector:update-v1-users-accept-access-by-username>
Note: The Multi-entity feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support. Accepts user access to an entity. ## User Access Permission You must make the calls as an administrator of the entity that you want to accept the user access to. This operation makes an HTTP PUT request to the /v1/users/{username}/accept-access endpoint
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 Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Multi-entity: Deny user access
<mule-zuora-connector:update-v1-users-deny-access-by-username>
Note: The Multi-entity feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support. Denies a user access to an entity. ## User Access Permission You must make the calls as an administrator of the entity that you want to deny the user access to. This operation makes an HTTP PUT request to the /v1/users/{username}/deny-access endpoint
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 deny the access. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Multi-entity: Send user access requests
<mule-zuora-connector:update-v1-users-request-access-by-username>
Note: The Multi-entity feature is in Limited Availability. If you want access to this feature, submit a request at Zuora Global Support. Sends access requests to the entities that a user wants to access. ## User Access Permission You must make the call as an administrator of the entity, in which the request user is created. Also, this administrator must have the permission to access the entities that the request user wants to access. This operation makes an HTTP PUT request to the /v1/users/{username}/request-access endpoint
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 who wants to access other entities. |
x |
|
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Update tasks in batch
<mule-zuora-connector:update-workflows-tasks-batch-update>
Updates a group of workflow tasks. This operation makes an HTTP PUT request to the /workflows/tasks/batch_update endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Authorization |
String |
|
x |
|
Zuora Entity Ids |
String |
An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. |
||
Zuora Track Id |
String |
A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon ( |
||
Content |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
Name of a variable in which to store the operation’s output |
||
Target Value |
String |
An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
MULE-ZUORA-CONNECTOR:BAD_REQUEST
-
MULE-ZUORA-CONNECTOR:CLIENT_ERROR
-
MULE-ZUORA-CONNECTOR:CONNECTIVITY
-
MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
-
MULE-ZUORA-CONNECTOR:NOT_FOUND
-
MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
-
MULE-ZUORA-CONNECTOR:SERVER_ERROR
-
MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
-
MULE-ZUORA-CONNECTOR:TIMEOUT
-
MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
-
MULE-ZUORA-CONNECTOR:UNAUTHORIZED
-
MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE
Types
Proxy
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Host |
String |
x |
||
Port |
Number |
x |
||
Username |
String |
|||
Password |
String |
|||
Non Proxy Hosts |
String |
Tls
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Enabled Protocols |
String |
A comma separated list of protocols enabled for this context. |
||
Enabled Cipher Suites |
String |
A comma separated list of cipher suites enabled for this context. |
||
Trust Store |
||||
Key Store |
||||
Revocation Check |
Trust Store
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Path |
String |
The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store. |
||
Password |
String |
The password used to protect the trust store. |
||
Type |
String |
The type of store used. |
||
Algorithm |
String |
The algorithm used by the trust store. |
||
Insecure |
Boolean |
If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk. |
Key Store
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Path |
String |
The location (which will be resolved relative to the current classpath and file system, if possible) of the key store. |
||
Type |
String |
The type of store used. |
||
Alias |
String |
When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default. |
||
Key Password |
String |
The password used to protect the private key. |
||
Password |
String |
The password used to protect the key store. |
||
Algorithm |
String |
The algorithm used by the key store. |
Standard Revocation Check
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Only End Entities |
Boolean |
Only verify the last element of the certificate chain. |
||
Prefer Crls |
Boolean |
Try CRL instead of OCSP first. |
||
No Fallback |
Boolean |
Do not use the secondary checking method (the one not selected before). |
||
Soft Fail |
Boolean |
Avoid verification failure when the revocation server can not be reached or is busy. |
Custom Ocsp Responder
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Url |
String |
The URL of the OCSP responder. |
||
Cert Alias |
String |
Alias of the signing certificate for the OCSP response (must be in the trust store), if present. |
Reconnection
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Fails Deployment |
Boolean |
When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy. |
||
Reconnection Strategy |
The reconnection strategy to use. |
Reconnect
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Frequency |
Number |
How often in milliseconds to reconnect |
||
Blocking |
Boolean |
If false, the reconnection strategy will run in a separate, non-blocking thread |
||
Count |
Number |
How many reconnection attempts to make. |
Reconnect Forever
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Frequency |
Number |
How often in milliseconds to reconnect |
||
Blocking |
Boolean |
If false, the reconnection strategy will run in a separate, non-blocking thread |
Expiration Policy
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Max Idle Time |
Number |
A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration |
||
Time Unit |
Enumeration, one of:
|
A time unit that qualifies the maxIdleTime attribute |
Http Response Attributes
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Status Code |
Number |
x |
||
Headers |
Object |
x |
||
Reason Phrase |
String |
x |
Repeatable In Memory Stream
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Initial Buffer Size |
Number |
The amount of memory that will be allocated to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. |
||
Buffer Size Increment |
Number |
This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. |
||
Max Buffer Size |
Number |
The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which all these attributes are expressed |
Repeatable File Store Stream
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
In Memory Size |
Number |
Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which maxInMemorySize is expressed |
Repeatable In Memory Iterable
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Initial Buffer Size |
Number |
The amount of instances that is initially be allowed to be kept in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances. |
||
Buffer Size Increment |
Number |
This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances. |
||
Max Buffer Size |
Number |
The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit. |
Repeatable File Store Iterable
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
In Memory Objects |
Number |
The maximum amount of instances that will be kept in memory. If more than that is required, then it will start to buffer the content on disk. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which maxInMemorySize is expressed |