salesforce Dreamforce On-Demand
Contact Us 1-800-596-4880
  1. Homepage
  2. Zuora Connector

  3. Zuora Connector Reference

All Connectors

Zuora Connector 5.0 Reference - Mule 4

Zuora Connector v5.0

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.

Release Notes: Zuora Connector Release Notes

Configurations

Name Type Description Default Value Required

Name

String

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

x

Connection

Basic Auth Connection Provider

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

MINUTES

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines 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

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

Connection Types

Basic Auth Connection Provider

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Connection Timeout

SECONDS

Use Persistent Connections

Boolean

If false, each connection will be closed after the first request is completed.

true

Max Connections

Number

The maximum number of outbound connections that will be kept open at the same time

-1

Connection Idle Timeout

Number

A timeout for how long a connection can remain idle before it is closed

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the connection Idle Timeout

SECONDS

Proxy Config

Proxy

Reusable configuration element for outbound connections through a proxy

Stream Response

Boolean

Whether or not received responses should be streamed

false

Response Buffer Size

Number

The space in bytes for the buffer where the HTTP response will be stored.

-1

Username

String

The username to authenticate the requests

Password

String

The password to authenticate the requests

Base Uri

String

Parameter base URI, each instance/tenant gets its own

https://rest.apisandbox.zuora.com:443

TLS Configuration

Tls

Reconnection

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.

Supported Operations

POST 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:

  • changeType is a keyword that specifies the type of change that occurred to the Invoice object. For all objects, the supported values of changeType are INSERT, UPDATE, and DELETE.

  • Invoice.Status is the value of the Invoice object’s Status field after the change occurred.

  • Invoice.Status_old is the value of the Invoice object’s Status field before the change occurred. In the above example, the value of baseObject would be Invoice.
    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-triggers endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Authorization

String

Bearer {token} for a valid OAuth token.

x

Zuora Entity Ids

String

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

Zuora Track Id

String

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

  • colon (:)

  • semicolon (;)

  • double quote (")

  • quote (').

Content

Binary

The content to use.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for requests to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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

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

x

Zuora Track Id

String

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

  • colon (:)

  • semicolon (;)

  • double quote (")

  • quote (')

Zuora Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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 is 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

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

x

Zuora Track Id

String

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

Zuora Entity Ids

String

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

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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>

This operation generates a bearer token that enables an OAuth client to authenticate with the Zuora REST API. The OAuth client must have been created using the Zuora UI. See Authentication for more information.

Do not set any authentication headers such as Authorization, apiAccessKeyId, or apiSecretAccessKey when using this operation.

should not use this operation to generate a large number of bearer tokens in a short period of time; each token should be used 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 by 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 in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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>

The Custom Objects service is in Limited Availability. To have access to the service, submit a request to Zuora Global Support.

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 Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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

Bearer {token} for a valid OAuth token.

x

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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>

The Custom Objects service is Limited Availability. To access the service, submit a request to Zuora Global Support.

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 Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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

Bearer {token} for a valid OAuth token.

x

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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>

The Custom Objects service is Limited Availability. To have access to the service, submit a request to Zuora Global Support.

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 Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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

Bearer {token} for a valid OAuth token.

x

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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>

The Custom Objects service is Limited Availability. To have access to the service, submit a request to Zuora Global Support.

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 Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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

Bearer {token} for a valid OAuth token.

x

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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 Data Query Job

<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 [operation/GET_DataQueryJob][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

Bearer {token} for a valid OAuth token.

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 (:), semicolon (;), double quote ("), and quote (').

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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

Bearer {token} for a valid OAuth token.

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 (:), semicolon (;), double quote ("), and quote (').

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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 usage records

<mule-zuora-connector:create-usage>

This operation creates usage records and makes an HTTP POST request to the /usage endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Authorization

String

Bearer {token} for a valid OAuth token.

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 (:), semicolon (;), double quote ("), and quote (').

Content Type

String

The type of the request content. - If you create multiple usage records, you must specify the value of this parameter to application/vnd.zuora.usage-bulk+json. - If you create a single usage record, you do not need to specify this field.

x

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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 usage file

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

This operation imports a usage file and makes an HTTP POST request to the /usage-imports endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Authorization

String

Bearer {token} for a valid OAuth token.

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 (:), semicolon (;), double quote ("), and quote (').

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

Description Content

String

The content of the 'Description' part.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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 Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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 Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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 autoPay field is set to true in the request, you must provide either the creditCard field or the hpmCreditCardPaymentMethodId field, 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 workEmail or personalEmail field is specified, then the account’s email delivery preference is automatically set to true, in which case, emails go to the workEmail or personalEmail address, if they exist. If neither field is specified, the email delivery preference is automatically set to false.

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 Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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.

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 to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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 Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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 Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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 of SubscriptionId must 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

Zuora Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Zuora Track Id

String

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

X Zuora WSDL Version

String

Zuora WSDL version number.

79

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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-Version header.
    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

Zuora Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Zuora Track Id

String

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

X Zuora WSDL Version

String

Zuora WSDL version number.

79

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

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

Objects per Call

50 objects are supported in a single call.

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 (:), semicolon (;), double quote ("), and quote (').

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 to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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:

  1. Use the create call to create a separate InvoiceSplitItem object for each split invoice that you want to create from the original draft invoice.

  2. Use the create call to create a single InvoiceSplit object to collect all of the InvoiceSplitItem objects.

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

Zuora Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Zuora Track Id

String

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

X Zuora WSDL Version

String

Zuora WSDL version number.

79

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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

Zuora Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Zuora Track Id

String

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

X Zuora WSDL Version

String

Zuora WSDL version number.

79

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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](https://knowledgecenter.zuora.com/DC_Developers/K_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-Version header. 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).

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 (:), semicolon (;), double quote ("), and quote (').

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 to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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

Zuora Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Zuora Track Id

String

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

X Zuora WSDL Version

String

Zuora WSDL version number.

79

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

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

Subscription Preview

You can preview invoices that would be generated by the subscribe call.

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

Zuora Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Zuora Track Id

String

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

X Zuora WSDL Version

String

Zuora WSDL version number.

79

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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-Version header. 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

Zuora Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Zuora Track Id

String

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

X Zuora WSDL Version

String

Zuora WSDL version number.

79

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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>

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. In the case where a normal "Create order" operation call will time out, use this operation instead to create an order asynchronously. A job will be creating the order in the back end; 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

Zuora Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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.

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 to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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>

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. In the case where a normal "Preview order" operation call will time out, use this operation instead to preview an order asynchronously. A job will be previewing the order in the back end; 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 Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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 Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/Credit_and_Debit_Memos/Rules_for_Generating_Invoices_and_Credit_Memos). 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](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_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:

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 Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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>

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/). 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 Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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 Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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>

Note: The Multi-entity 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/). 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).

Note that you must finish all the [prerequisites](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity/C_Business_Objects_Sharing_Across_Entities/B_Products_Sharing_Across_Entities/Share_Products) 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 Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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

Zuora Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 Access Key Id

String

Account username

x

Api Secret Access Key

String

Account password

x

Content Type

String

Must be set to "application/json"

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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>

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/). 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 Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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: * charges > amount * charges > memoItemAmount * charges > chargeId * charges > productRatePlanChargeId * charges > comment * charges > description

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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 useEmailTemplateSetting field is set to false.

    • The email addresses are not specified in the emailAddresses field.

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 Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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>

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/). 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 (:), semicolon (;), double quote ("), and quote (').

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 to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE

  • MULE-ZUORA-CONNECTOR:TIMEOUT

  • MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS

  • MULE-ZUORA-CONNECTOR:UNAUTHORIZED

  • MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Request Breakdown of Credit Memo Items by Order

<mule-zuora-connector:create-v1-creditmemos-items-amount-breakdown-by-order>

This feature is in Limited Availability. Retrieve specified credit memo items which are broken down by orders. One credit memo item might be broken down into a list of order related items.

You can only use this operation to retrieve breakdowns of credit memos whose source value is BillRun or API. The maximum number of credit memo items to retrieve is 1000. This operation makes an HTTP POST request to the /v1/creditmemos/items/amountBreakdownByOrder 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.

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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 wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/). 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 Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 to use repeatable streams.

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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>

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/). 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](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/{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 Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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 wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/). Creates taxation items for a credit memo. This operation 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 Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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>

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/). 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](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/debitmemos 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 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: * charges > amount * charges > memoItemAmount * charges > chargeId * charges > productRatePlanChargeId * charges > comment * charges > description

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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 wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/). 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 useEmailTemplateSetting field is set to false.

    • The email addresses are not specified in the emailAddresses field.

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 Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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 (:), semicolon (;), double quote ("), and quote (').

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 to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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>

This operation creates debit memo PDFs and 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 Entity Ids

String

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 to use repeatable streams.

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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 wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/). Creates taxation items for a debit memo. This operation 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 Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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 wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).

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 wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).

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 (:), semicolon (;), double quote ("), and quote (').

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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 wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/). Creates an entity in a multi-entity hierarchy. ## User Access Permission

You must make the call as a global entity administrator.

Notes

It is recommended that 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 Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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 Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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 Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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 Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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 Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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 Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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>

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/). Creates an ad-hoc credit memo from an invoice.

You can create a credit 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}/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 Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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: * items > comment * items > description

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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 wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/). 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 Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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: * items > comment * items > description

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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 useEmailTemplateSetting field is set to false.

    • The email addresses are not specified in the emailAddresses field.

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 Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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 (:), semicolon (;), double quote ("), and quote (').

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 to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE

  • MULE-ZUORA-CONNECTOR:TIMEOUT

  • MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS

  • MULE-ZUORA-CONNECTOR:UNAUTHORIZED

  • MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE

Request breakdown of invoice items by order

<mule-zuora-connector:create-v1-invoices-items-amount-breakdown-by-order>

Note: This feature is in Limited Availability. Retrieves the specified invoice items which are broken down by orders. One invoice item might be broken down into a list of order related items. The maximum number of invoice items to retrieve is 1000. This operation makes an HTTP POST request to the /v1/invoices/items/amountBreakdownByOrder 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.

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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 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 either all be 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 Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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 Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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

Zuora Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Zuora Track Id

String

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

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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>

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). 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 created by 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

Zuora Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Zuora Track Id

String

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

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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

Zuora Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Zuora Track Id

String

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

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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

Zuora Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Zuora Track Id

String

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

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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 create a data source export, use the CRUD: Retrieve Export operation (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.

This operation supports the 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 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

Zuora Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Zuora Track Id

String

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

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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

Zuora Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Zuora Track Id

String

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

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 to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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

Zuora Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Zuora Track Id

String

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

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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

Zuora Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Zuora Track Id

String

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

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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

Zuora Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Zuora Track Id

String

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

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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>

CRUD: Create payment method This 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

Zuora Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Zuora Track Id

String

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

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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>

CRUD: Create Product This 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

Zuora Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Zuora Track Id

String

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

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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>

CRUD: Create ProductRatePlan This 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

Zuora Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Zuora Track Id

String

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

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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

Zuora Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Zuora Track Id

String

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

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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>

CRUD: Create refund This 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

Zuora Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Zuora Track Id

String

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

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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>

CRUD: Create TaxationItem This 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

Zuora Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Zuora Track Id

String

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

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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>

CRUD: Create UnitOfMeasure This 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

Zuora Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Zuora Track Id

String

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

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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>

CRUD: Create usage This 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

Zuora Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Zuora Track Id

String

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

Content

Binary

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

Streaming Strategy

Configure to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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 Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Throws

  • MULE-ZUORA-CONNECTOR:BAD_REQUEST

  • MULE-ZUORA-CONNECTOR:CLIENT_ERROR

  • MULE-ZUORA-CONNECTOR:CONNECTIVITY

  • MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR

  • MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE

  • MULE-ZUORA-CONNECTOR:NOT_FOUND

  • MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED

  • MULE-ZUORA-CONNECTOR:SERVER_ERROR

  • MULE-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 may 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 Entity Ids

String

An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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.

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 to use repeatable streams.

Custom Query Parameters

Object

Custom Headers

Object

Response Timeout

Number

The timeout for request to the remote service.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

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

Target Value

String

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

#[payload]

Reconnection Strategy