Zuora Connector 6.0 Reference | MuleSoft Documentation
# Zuora Connector 6.0 Reference
Anypoint Connector for Zuora (Zuora Connector) enables access to the Zuora platform. This connector exposes all of the operations provided by Zuora’s REST API.
## Configurations
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
The name for this configuration. Connectors reference the configuration with this name.  
Connection | 
  * Basic Auth Connection Provider
  * Oauth2 Connection Provider

| The connection types to provide to this configuration.  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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.  
The identifier of this element used to reference it in other components  
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 when as appropriate.  
## Connection Types
### Basic Auth Connection Provider
Uses a username and password to connect.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Default Headers |  Array of Default Header  
Query Parameters |  Array of Default Query Param  
Connection Timeout | Timeout for establishing connections to the remote service.  
Connection Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the **Connection Timeout**.  
Use Persistent Connections | If false, each connection is closed after the first request is completed.  
Max Connections | Maximum number of outbound connections to keep open concurrently.  
Connection Idle Timeout | Timeout for how long a connection can remain idle before it is closed.  
Connection Idle Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Connection Idle Timeout**.  
Proxy Config | Reusable configuration element for outbound connections through a proxy.  
Stream Response | Whether or not to stream received responses.  
Response Buffer Size | The space in bytes for the buffer where the HTTP response will be stored.  
Username | Username to authenticate the requests  
Password | Password to authenticate the requests  
Base Uri | Parameter base URI, each instance or tenant gets its own base URI. | `https://rest.apisandbox.zuora.com:443`  
TLS Configuration  
Reconnection |  | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.  
### Oauth2 Connection Provider
Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to Configuring OAuth 2.0 for Connectors or Configuring OAuth 2.0 for Connectors on CloudHub.
Uses the Client Credentials grant type to connect using the client ID, client secret, and token URL.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Default Headers |  Array of Default Header  
Query Parameters |  Array of Default Query Param  
Connection Timeout | The timeout for establishing connections to the remote service.  
Connection Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit that qualifies the **Connection Timeout**.  
Use Persistent Connections | If false, each connection is closed after the first request is completed.  
Max Connections | Maximum number of outbound connections to keep open concurrently.  
Connection Idle Timeout | Timeout for how long a connection can remain idle before it is closed.  
Connection Idle Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS
| A time unit that qualifies the **Connection Idle Timeout**.  
Proxy Config | Reusable configuration element for outbound connections through a proxy.  
Stream Response | Whether or not to stream received responses.  
Response Buffer Size | The space in bytes for the buffer where the HTTP response will be stored.  
Base Uri | Parameter base URI. Each instance or tenant gets its own base URI. | `https://rest.apisandbox.zuora.com:443`  
TLS Configuration  
Reconnection |  | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.  
Client Id | OAuth client ID that is registered with the service provider.  
Client Secret | OAuth client secret that is registered with the service provider.  
Token Url | Service provider’s token endpoint URL. | `https://rest.apisandbox.zuora.com/oauth/token`  
OAuth scopes to request during the OAuth dance. If the scopes are not provided, the scopes in the annotation are used.  
Object Store | A reference to the object store to use to store each resource owner ID’s data. If the object store is not specified, Mule automatically provisions the default object store.  
## Supported Operations
  * Create an Event Trigger
  * Create an Email Template
  * Create a notification definition
  * Generate an OAuth Token
  * Update or Delete Custom Object Records as a Batch
  * Create Custom Object Definition
  * Update Custom Object Definition
  * Create Custom Object Records
  * Submit Data Query
  * Submit Multiple Settings Requests as a Batch
  * Create Accounting Code
  * Create Accounting Period
  *   * Create Job to Hard Delete Billing Document Files
  * Generate Billing Documents by Account
  *   * Create Order Asynchronously
  * Preview Order Asynchronously
  *   * Email Billing Documents Generated From Bill Run
  * Create Billing Preview Run
  * Perform Mass Action
  * Multi-entity: Share a Product With an Entity
  * Establish Connection to Zuora REST API Service
  * Create Credit Memo from Charge
  *   * Upload File for Credit Memo
  * Create Credit Memo PDF
  *   * Create Taxation Items for Credit Memo
  * Create Debit Memo from Charge
  *   * Upload File for Debit Memo
  * Create Debit Memo PDF
  * Create Taxation Items for Debit Memo
  * Create Document Properties
  * Multi-entity: Create entity
  * Multi-entity: Initiate Connection
  *   *   *   * Return HMAC signatures
  * Create Credit Memo from Invoice
  * Create debit memo from invoice
  *   * Upload File for Invoice
  * Create Summary Journal Entry
  * Create Journal Run
  * CRUD: Create Account
  * CRUD: Create Bill Run
  * CRUD: Create Contact
  * CRUD: Create CreditBalanceAdjustment
  * CRUD: Create Export
  * Object POSTFeature
  * CRUD: Create Import
  * CRUD: Create InvoiceAdjustment
  * CRUD: Create InvoicePayment
  * CRUD: Create payment
  * CRUD: Create Payment Method
  * CRUD: Create Product
  * CRUD: Create ProductRatePlan
  * CRUD: Create product rate plan charge
  * CRUD: Create Refund
  * CRUD: Create TaxationItem
  * CRUD: Create UnitOfMeasure
  * CRUD: Create usage
  * Create Billing Preview
  * Invoice and Collect
  *   *   * Create Payment Method
  *   * Create Credit Card Payment Method
  * Create Apple Pay Payment Method
  * Create Stored Credential Profile
  * Cancel Stored Credential Profile
  * Expire Stored Credential Profile
  *   * Create Payment Run
  *   *   * Generate Quotes Document
  * Create Revenue Schedule for Credit Memo Item (manual distribution)
  * Create Revenue Schedule for Credit Memo Item (distribute by date range)
  * Create Revenue Schedule for Debit Memo Item (manual distribution)
  * Create revenue schedule for debit memo item (distribute by date range)
  * Create revenue schedule for Invoice Item Adjustment (manual distribution)
  * Create revenue schedule for Invoice Item Adjustment (distribute by
  * Create revenue schedule for Invoice Item (manual distribution)
  * Create Revenue Schedule for Invoice Item (distribute by date range)
  * Create Revenue Schedule on Subscription Charge
  * Generate RSA signature
  * Decrypt RSA signature
  * Create sequence sets
  * Create subscription
  * Preview Subscription
  *   * Import a workflow
  *   * Remove an event trigger
  * Delete an email template
  * Delete a notification definition
  * Delete custom object definition
  * Delete custom object record
  * Cancel data query job
  * Delete Accounting Code
  * Delete accounting period
  * Delete attachments
  * Delete credit memo
  *   * Delete document properties
  * Multi-entity: Delete Entity
  * Delete summary journal entry
  * Delete journal run
  * CRUD: Delete account
  * CRUD: Delete amendment
  * CRUD: Delete bill run
  * CRUD: Delete contact
  * CRUD: Delete Feature
  * CRUD: Delete InvoiceAdjustment
  * CRUD: Delete invoice
  * CRUD: Delete InvoiceItemAdjustment
  * CRUD: Delete payment
  * CRUD: Delete payment method
  * CRUD: Delete Product
  * CRUD: Delete ProductFeature
  * CRUD: Delete ProductRatePlan
  * CRUD: Delete product rate plan charge
  * CRUD: Delete refund
  * CRUD: Delete Subscription
  * CRUD: Delete TaxationItem
  * CRUD: Delete UnitOfMeasure
  * CRUD: Delete usage
  *   * Delete payment method
  * Delete payment run
  *   *   * Delete revenue schedule
  * Delete sequence set
  * Delete taxation item
  * Delete a workflow by ID
  * Query event triggers
  * Get an event trigger by ID
  * Query email templates
  * Get an email template
  * Query notification definitions
  * Get a notification definition
  * Get all custom object definitions
  * Get custom object definition
  * Query custom object records
  * Get custom object record
  * Get data query jobs
  * Get data query job
  * List all settings
  * Get all Accounting Codes
  * Query an Accounting Code
  * Get all accounting periods
  * Get accounting period
  * Get job of hard deleting billing document files
  *   * Get account summary
  * Get amendments by key
  * Get amendments by subscription ID
  * Get job status and response
  *   * View attachments list
  * Get billing documents
  * Get Billing Preview Run
  * Get mass action result
  *   * Get Product Catalog
  * Get charge summary details by CRS number
  * Get charge summary details by charge ID
  * Get Credit Memos
  *   * Get credit Memo Items
  * Get credit memo item
  * Get taxation items of credit memo item
  * Get credit memo parts
  * Get credit memo part
  * Get credit memo part items
  * Get credit memo part item
  * Get custom foreign currency exchange rates
  * Get Debit Memos
  * Get debit memo application parts
  *   * Get Debit Memo Items
  *   * Get taxation items of debit memo item
  *   * Get document properties
  * Multi-entity: Get entities
  * Multi-entity: Get entity by Id
  * Multi-entity: Get connections
  * Return Hosted Pages
  * Get invoice application parts
  *   *   * Get taxation items of invoice item
  * Get summary journal entry
  * Get all summary journal entries in a journal run
  *   * Get callout notification histories
  * Get email notification histories
  * CRUD: Get account
  * CRUD: Get amendment
  * CRUD: Get bill run
  * CRUD: Retrieve CommunicationProfile
  * CRUD: Get contact
  * CRUD: Retrieve CreditBalanceAdjustment
  * CRUD: Retrieve Export
  * CRUD: Retrieve Feature
  * CRUD: Retrieve Import
  * CRUD: Retrieve InvoiceAdjustment
  * CRUD: Get invoice
  * CRUD: Retrieve InvoiceItemAdjustment
  * CRUD: Retrieve InvoiceItem
  * CRUD: Retrieve InvoicePayment
  * CRUD: Retrieve InvoiceSplit
  * CRUD: Retrieve InvoiceSplitItem
  * CRUD: Get payment
  * CRUD: Get payment method
  * CRUD: Get payment method snapshot
  * CRUD: Retrieve PaymentMethodTransactionLog
  * CRUD: Get payment transaction log
  * CRUD: Retrieve Product
  * CRUD: Retrieve ProductFeature
  * CRUD: Retrieve ProductRatePlan
  * CRUD: Get product rate plan charge
  * CRUD: Retrieve ProductRatePlanChargeTier
  * CRUD: Retrieve RatePlan
  * CRUD: Get rate plan charge
  * CRUD: Retrieve RatePlanChargeTier
  * CRUD: Get refund
  * CRUD: Retrieve RefundInvoicePayment
  * CRUD: Retrieve RefundTransactionLog
  * CRUD: Retrieve Subscription
  * CRUD: Retrieve SubscriptionProductFeature
  * CRUD: Retrieve TaxationItem
  * CRUD: Retrieve UnitOfMeasure
  *   * Get all orders
  *   * Get order metrics for evergreen subscription
  * Get orders by invoice owner
  * Get orders by subscription number
  * Get orders by subscription owner
* CRUD: Retrieve Export
  * CRUD: Retrieve Feature
  * CRUD: Retrieve Import
  * CRUD: Retrieve InvoiceAdjustment
  * CRUD: Get invoice
  * CRUD: Retrieve InvoiceItemAdjustment
  * CRUD: Retrieve InvoiceItem
  * CRUD: Retrieve InvoicePayment
  * CRUD: Retrieve InvoiceSplit
  * CRUD: Retrieve InvoiceSplitItem
  * CRUD: Get payment
  * CRUD: Get payment method
  * CRUD: Get payment method snapshot
  * CRUD: Retrieve PaymentMethodTransactionLog
  * CRUD: Get payment transaction log
  * CRUD: Retrieve Product
  * CRUD: Retrieve ProductFeature
  * CRUD: Retrieve ProductRatePlan
  * CRUD: Get product rate plan charge
  * CRUD: Retrieve ProductRatePlanChargeTier
  * CRUD: Retrieve RatePlan
  * CRUD: Get rate plan charge
  * CRUD: Retrieve RatePlanChargeTier
  * CRUD: Get refund
  * CRUD: Retrieve RefundInvoicePayment
  * CRUD: Retrieve RefundTransactionLog
  * CRUD: Retrieve Subscription
  * CRUD: Retrieve SubscriptionProductFeature
  * CRUD: Retrieve TaxationItem
  * CRUD: Retrieve UnitOfMeasure
  *   * Get all orders
  *   * Get order metrics for evergreen subscription
  * Get orders by invoice owner
  * Get orders by subscription number
  * Get orders by subscription owner
  * Get term information for subscription
  * Get credit card payment methods for account
  * Get stored credential profiles
  * Get payment runs
  *   * Get payment run summary
  * Get payment gateways
  * Get all payments
  *   *   *   * Get payment part items
  * Get payment part item
  * Get product rate plans
  * Get all refunds
  *   *   *   * Get refund part items
  *   * Get revenue event details
  * Get revenue events for a revenue schedule
  * Get revenue items by charge revenue summary number
  * Get revenue items by revenue event number
  * Get revenue items by revenue schedule
  * Get revenue recognition rule by product rate plan charge
  * Get revenue recognition rule by subscription charge
  * Get revenue schedule details
  * Get revenue schedule by credit memo item ID
  * Get revenue schedule by debit memo item ID
  * Get revenue schedule by invoice item adjustment
  * Get revenue schedule by invoice item ID
  * Get all revenue schedules of product charge by charge ID and billing
  * Get revenue schedule by subscription charge
  * Get sequence sets
  * Get sequence set
  * Get the revenue automation start date
  * Get subscriptions by account
  * Get subscriptions by key
  * Get subscriptions by key and version
  * Get taxation item
  *   *   * Multi-entity: Get entities that a user can access
  *   * Get a workflow by ID
  *   * Get workflow task usage
  *   *   * Update individual fields in a custom object record
  * Update an Event Trigger
  * Update an email template
  * Update a notification definition
  * Update custom object record
  * Activate accounting code
  * Update an accounting code
  * Deactivate accounting code
  * Update accounting period
  * Close accounting period
  * Set accounting period to pending close
  * Re-open accounting period
  *   *   *   *   *   *   * Update Credit Memo
  *   *   * Unapply credit memo
  *   * PUT Batch Update Debit Memos
  *   *   *   *   * Update document properties
  * Multi-entity: Update entity
  * Multi-entity: Provision entity
  * Multi-entity: Accept connection
  * Multi-entity: Deny connection
  * Multi-entity: Disconnect connection
  * Update invoices
  *   *   *   * Update basic information of a summary journal entry
  * Cancel summary journal entry
  *   * CRUD: Update account
  * CRUD: Update amendment
  * CRUD: Post or Cancel bill run
  * CRUD: Update contact
  * CRUD: Update CreditBalanceAdjustment
  * Object PUTFeature
  * CRUD: Update InvoiceAdjustment
  * CRUD: Update invoice
  * CRUD: Update InvoicePayment
  * CRUD: Update payment
  * CRUD: Update payment method
  * CRUD: Update Product
  * CRUD: Update ProductRatePlan
  * CRUD: Update product rate plan charge
  * CRUD: Update ProductRatePlanChargeTier
  * CRUD: Update rate plan charge
  * CRUD: Update refund
  * CRUD: Update Subscription
  * CRUD: Update TaxationItem
  * CRUD: Update UnitOfMeasure
  * CRUD: Update usage
  * Update order custom fields
  * Update order action trigger dates
  * Update credit card payment method
  * Scrub payment method
  * Verify payment method
  * Update payment run
  *   *   *   *   *   *   *   * Update custom fields on revenue items by revenue event number
  * Update custom fields on revenue items by revenue schedule number
  * Update revenue schedule basic information
  * Distribute revenue across accounting periods
  * Distribute revenue on specific date
  * Distribute revenue by recognition start and end dates
  * PUT Rev Pro Accounting Codes
  * Update Sequence Set
  * Update subscription
  *   * Update Subscription Custom Fields
  *   *   * Suspend subscription
  * Update subscription custom fields of a specified subscription version
  * Update taxation item
  * Multi-entity: Accept user access
  * Multi-entity: Deny user access
  * Multi-entity: Send user access requests
  * Update tasks in batch
## Create an Event Trigger
`<mule-zuora-connector:create-events-event-triggers>`
You can define an event trigger on any of the following objects:
  * Account
  * AccountingCode
  * AccountingPeriod
  * Amendment
  * BillingRun
  * Contact
  * CreditBalanceAdjustment
  * CreditMemo
  * CreditMemoApplication
  * CreditMemoApplicationItem
  * CreditMemoItem
  * DebitMemo
  * DebitMemoItem
  * Feature
  * Invoice
  * InvoiceAdjustment
  * InvoiceItem
  * InvoiceItemAdjustment
  * JournalEntry
  * JournalEntryItem
  * Order
  * OrderAction
  * Payment
  * PaymentApplication
  * PaymentMethod
  * PaymentPart
  * Product
  * ProductFeature
  * ProductRatePlan
  * ProductRatePlanCharge
  * RatePlan
  * RatePlanCharge
  * Refund
  * RefundApplication
  * RevenueEvent
  * RevenueEventItem
  * RevenueSchedule
  * RevenueScheduleItem
  * Subscription
  * SubscriptionProductFeature
  * TaxationItem
  * Usage


The `baseObject` field specifies the object on which to define a trigger. The `condition` field is a JEXL expression that specifies when to trigger events. The expression can contain fields from the object that the trigger is defined on.
The condition cannot contain fields from data source objects that are joined to the object that the trigger is defined on. For example, the following condition causes an event to be triggered whenever an invoice is posted with an amount greater than 1000:
`changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 1000`
Where:
  * `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 | The name of the configuration to use.  
Authorization |  `Bearer {token}` for a valid OAuth token.  
Zuora Entity Ids |  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 |  A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the 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 (`'`).

  
The content to use | #[payload]  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable.. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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 | The name of the configuration to use.  
Authorization | `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.  
Zuora Track Id |  A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls to assist with troubleshooting in the event of 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 | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora multi-entity enabled, you do not need to set this header.  
The content to use. | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component.  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * Configurations
| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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 will be evaluated to see if the notification definition is qualified to handle the incoming events during runtime. If the notification is qualified, it will send the email and invoke the callout if it has an email template or a callout. This operation makes an HTTP POST request to the /notifications/notification-definitions endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Authorization | `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.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of 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 | 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.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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>`
Generates a bearer token that enables an OAuth client to authenticate with the Zuora REST API. The OAuth client must be created using the Zuora UI. See Authentication for more information.
When using this operation, do not set any authentication headers such as `Authorization`, `apiAccessKeyId`, or `apiSecretAccessKey`.   
---  
Do not use this operation to generate a large number of bearer tokens in a short period of time; use each token until it expires. If you receive a `429 Too Many Requests` response when using this operation, reduce the frequency of requests. This endpoint is rate limited according to IP address. The rate limit is 100 requests per minute. This operation makes an HTTP POST request to the /oauth/token endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Zuora Track Id |  A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the 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 (`'`).

  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * Configurations
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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>`
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 | The name of the configuration to use.  
Specifies the custom object''s API name as object. It is case-sensitive.  
Zuora Track Id |  A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of 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 | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 | `Bearer {token}` for a valid OAuth token.  
Zuora Version | API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in the request header if you expect a specific response schema.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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>`
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.
## Create Custom Object Definition
`<mule-zuora-connector:create-objects-definitions-default>`
This operation enables you to Post a custom object definition with the given type. The **label** field is the UI label of the custom object. The **object** field contains the API Name of the custom object.
This operation makes an HTTP POST request to the `/objects/definitions/default` endpoint.
### Limitations
The custom object definition has the following limitations:
  * The maximum number of characters for the Custom Object API Name (`object`) is 64.
  * The maximum number of characters for the Custom Object Label (`label`) is 64.
  * The maximum number of characters for the Custom Object Description 250.
  * The maximum number of custom fields in an custom object is 50.
  * The maximum number of characters for the custom field API name is 64.
  * The maximum number of characters for the custom field label (`label`) is 64.
  * The maximum number of characters for the custom field Description is 250.
  * The maximum number of picklist options is 250.
  * The default maximum number of characters for the Text field is 512.


You can configure the maximum length, up to 4,096, characters when creating or updating the custom object definition using an API.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of 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 | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 | `Bearer {token}` for a valid OAuth token.  
Zuora Version | API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in the request header if you expect a specific response schema.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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>`
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 | The name of the configuration to use.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of 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 | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 | `Bearer {token}` for a valid OAuth token.  
Zuora Version | API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in the request header if you expect a specific response schema.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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>`
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.
### Throws
  * MULE-ZUORA-CONNECTOR:BAD_REQUEST
  * MULE-ZUORA-CONNECTOR:CLIENT_ERROR
  * MULE-ZUORA-CONNECTOR:CONNECTIVITY
  * MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
  * MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
  * MULE-ZUORA-CONNECTOR:NOT_FOUND
  * MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
  * MULE-ZUORA-CONNECTOR:SERVER_ERROR
  * MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
  * MULE-ZUORA-CONNECTOR:TIMEOUT
  * MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
  * MULE-ZUORA-CONNECTOR:UNAUTHORIZED
  * MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE


## Create Custom Object Records
`<mule-zuora-connector:create-objects-records-default-by-object>`
This operation creates custom object records with the given type. When creating records of a custom object type, the `200` response provides the following information:
  * A list of records that have been successfully processed and stored
  * A list of records that have not been successfully processed and therefore not stored.


This operation makes an HTTP POST request to the `/objects/records/default/{object}` endpoint.
### Limitations
This call has the following limitations:
  * The maximum number of records that you can create by one call is 1,000.
  * The storage of empty strings in records is not supported.
  * Null values must be formatted as the following example: `{ "records": [ { "fieldName__c": null } ] }`


### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Specifies the custom object''s API name as object. It is case-sensitive.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of 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 | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 | `Bearer {token}` for a valid OAuth token.  
Zuora Version | API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in the request header if you expect a specific response schema.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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 Data Query
`<mule-zuora-connector:create-query-jobs>`
This operation submits a data query to be performed by Zuora and creates a query job.
You can use Get data query job to track the status of the query job and obtain the URL of the query results.
This operation makes an HTTP POST request to the `/query/jobs` endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Authorization | `Bearer {token}` for a valid OAuth token.  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of 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 (`'`).  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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
| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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 | The name of the configuration to use.  
Authorization | `Bearer {token}` for a valid OAuth token.  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of 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 (`'`).  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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 | The name of the configuration to use.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of 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 | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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.
### Throws
  * MULE-ZUORA-CONNECTOR:BAD_REQUEST
  * MULE-ZUORA-CONNECTOR:CLIENT_ERROR
  * MULE-ZUORA-CONNECTOR:CONNECTIVITY
  * MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
  * MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
  * MULE-ZUORA-CONNECTOR:NOT_FOUND
  * MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
  * MULE-ZUORA-CONNECTOR:SERVER_ERROR
  * MULE-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 | The name of the configuration to use.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of 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 | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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 | The name of the configuration to use.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of 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 | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 | The minor version of the Zuora REST API. You only need to set this parameter if you use the following fields: * invoice * collect * runBilling * targetDate  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER
| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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 | The name of the configuration to use.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of 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 | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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 | The name of the configuration to use.  
The ID of the customer account that billing documents are generated for. For example, 8a8082e65b27f6c3015ba3e326b26419.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of 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 | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * Configurations
| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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`
  * `SubscriptionId` The value of `SubscriptionId` must be the same for each Amendment object.


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 | The name of the configuration to use.  
Reject Unknown Fields | Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is: `json { "message": "Error - unrecognized fields" } ` By default, Zuora ignores unknown fields in the request body.  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of 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 | Zuora WSDL version number.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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
## 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 | The name of the configuration to use.  
Reject Unknown Fields | Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is: `json { "message": "Error - unrecognized fields" } ` By default, Zuora ignores unknown fields in the request body.  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of 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 | Zuora WSDL version number.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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 | The name of the configuration to use.  
Reject Unknown Fields | Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is: `json { "message": "Error - unrecognized fields" } ` By default, Zuora ignores unknown fields in the request body.  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of 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 | Zuora WSDL version number.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * Configurations
| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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 | The name of the configuration to use.  
Reject Unknown Fields | Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is: `json { "message": "Error - unrecognized fields" } ` By default, Zuora ignores unknown fields in the request body.  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of 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 | Zuora WSDL version number.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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 | The name of the configuration to use.  
Reject Unknown Fields | Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is: `json { "message": "Error - unrecognized fields" } ` By default, Zuora ignores unknown fields in the request body.  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of 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 | Zuora WSDL version number.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream
| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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 (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 xhttps://knowledgecenter.zuora.com/DC_Developers/G_SOAP_API/Zuora_SOAP_API_Version_History[Zuora Object Query Language].


### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Reject Unknown Fields | Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is: `json { "message": "Error - unrecognized fields" } ` By default, Zuora ignores unknown fields in the request body.  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of 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 | Zuora WSDL version number.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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
| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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 | The name of the configuration to use.  
Reject Unknown Fields | Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is: `json { "message": "Error - unrecognized fields" } ` By default, Zuora ignores unknown fields in the request body.  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of 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 | Zuora WSDL version number.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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.
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 | The name of the configuration to use.  
Reject Unknown Fields | Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is: `json { "message": "Error - unrecognized fields" } ` By default, Zuora ignores unknown fields in the request body.  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of 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 | Zuora WSDL version number.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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).
### 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 | The name of the configuration to use.  
Reject Unknown Fields | Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is: `json { "message": "Error - unrecognized fields" } ` By default, Zuora ignores unknown fields in the request body.  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of 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 | Zuora WSDL version number.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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>`
This operation is only available if you have the Orders feature enabled. This operation is in **Limited Availability**.   
---  
If a normal "Create order" operation call is likely to time out, use this operation instead to create an order asynchronously. When an order is created asynchronously, a job creates the order in the back end and the job ID will be returned for tracking the job status and result.
This operation makes an HTTP POST request to the /v1/async/orders endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Return Ids | Specify whether to return IDs for the [Get job status and response](https://www.zuora.com/developer/api-reference/#operation/GET_JobStatusAndResponse) operation. If you set this query parameter to `true`, the corresponding IDs, which are associated with the numbers returned in this operation, can be returned in the "Get job status and response" response body.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of 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 | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 | The minor version of the Zuora REST API. You need to set this parameter if you want to use the following fields: * subscriptions * subscriptionNumbers * subscriptionIds (when the `returnId` query parameter is set to `true`)  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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
| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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>`
This operation is only available if you have the Zuora Orders feature enabled.   
---  
This operation is **Limited Availability**.
If a normal "Preview order" operation call is likely to time out, use this operation instead to preview an order asynchronously. When you use this operation, a job previews the order in the back end and the job ID will be returned for tracking the job status and result.
This operation makes an HTTP POST request to the /v1/async/orders/preview endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of 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 | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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 | The name of the configuration to use.  
description | Description of the attachment document.  
Associated Object Type | Specify one of the following values: Account, Subscription, or Invoice.  
Associated Object Key | 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.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of 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 | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 | The content of the 'File' part. | #[payload]  
File Filename | The filename of the 'File' part (just the name, do not include path).  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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
| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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. Credit memos are only available if you have the Invoice Settlement feature enabled. Using this API operation, the billing documents are sent to the email addresses specified in the **To Email** field of the email templates. The email template used for each billing document is set in the **Delivery Options** panel of the **Edit notification** dialog from the Zuora UI. See Edit Email Templates for more information about how to edit the **To Email** field in the email template.
### Notes
  * Even though no field is required in the Request body, you still need to specify `{}` in the request. Otherwise, an error will be returned.
  * You can only email posted billing documents.
  * You must activate the following notifications before emailing invoices and credit memos: + **Manual Email For Invoice | Manual Email For Invoice** - **Email Credit Memo | Manually email Credit Memo**
  * To include the invoice PDF in the email, select the **Include Invoice PDF** check box in the **Edit notification** dialog from the Zuora UI. To include the credit memo PDF in the email, select the **Include Credit Memo PDF** check box in the **Edit notification** dialog from the Zuora UI. See [Create and Edit Notifications](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/C_Create_Notifications#section_2) for more information.
  * Zuora sends the email messages based on the email template you set.
  * You can set the email template to use in the **Delivery Options** panel of the **Edit notification** dialog from the Zuora UI. By default, the following templates are used for billing documents:
    * Invoices: Invoice Posted Default Email Template
    * Credit memos: Manual Email for Credit Memo Default Template See [Create and Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information.


This operation makes an HTTP POST request to the /v1/bill-runs/{billRunId}/emails endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Bill Run Id | The ID of the bill run. For example, 2c92c8f95d0c886e015d11287a8f0f8b.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of 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 | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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>`
This feature is in **Limited Availability**. If you want access to this feature, submit a request to Zuora Global Support. Creates billing preview runs for multiple customer accounts.   
---  
You can run up to 10 billing previews in batches concurrently. A single batch of customer accounts can only have one billing preview run at a time. So you can have up to 10 batches running at the same time. If you create a billing preview run for all customer batches, you cannot create another billing preview run until this preview run is completed.
This operation makes an HTTP POST request to the /v1/billing-preview-runs endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of 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 | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS
| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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 | The name of the configuration to use.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of 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 | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 | The content of the 'File' part. | #[payload]  
File Filename | The filename of the 'File' part (just the name, do not include path).  
Params Content | The content of the 'parameters' part.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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>`
The Multi-entity feature is in **Limited Availability**. If you wish to have access to the feature, submit a request to Zuora Global Support. Shares a product with a target entity. Zuora synchronizes the shared products to the target entity after sharing. For more information about product sharing, see [Products Sharing Across Entities](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity/C_Business_Objects_Sharing_Across_Entities/B_Products_Sharing_Across_Entities).   
---  
You must finish all the prerequisites before sharing products with other entities.
Only source entity administrators have permission to share products with other entities.
You must make the call as a source entity administrator. - Currently, you can only share a product with one entity at a time. An error occurs if you try to share a product to more than one entity.
This operation makes an HTTP POST request to the /v1/catalog/products/{product-id}/share endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Product id | The unique ID of the product you want to share. For example, 8a808255575bdae4015774e9602e16fe.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of 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 | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER
| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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 | The name of the configuration to use.  
Api Access Key Id | Account username  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
Api Secret Access Key | Account password  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of 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 | Must be set to "application/json"  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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>`
The Invoice Settlement feature is in **Limited Availability**. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request to Zuora Global Support. 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 | The name of the configuration to use.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of 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 | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 | 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`  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream
| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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 to Zuora Global Support.
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 | The name of the configuration to use.  
Credit Memo Id | The ID of a posted credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of 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 | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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>`
The Invoice Settlement feature is in **Limited Availability**. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request to Zuora Global Support.   
---  
This operation uploads an externally generated PDF file for a credit memo that is in Draft or Posted status. This operation has the following restrictions:
  * Only the PDF file format is supported.
  * The maximum size of the PDF file to upload is 4 MB.
  * A maximum of 50 PDF files can be uploaded for one credit memo.
## Upload File for Credit Memo
`<mule-zuora-connector:create-v1-creditmemos-files-by-credit-memo-id>`
The Invoice Settlement feature is in **Limited Availability**. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request to Zuora Global Support.   
---  
This operation uploads an externally generated PDF file for a credit memo that is in Draft or Posted status. This operation has the following restrictions:
  * Only the PDF file format is supported.
  * The maximum size of the PDF file to upload is 4 MB.
  * A maximum of 50 PDF files can be uploaded for one credit memo.


This operation makes an HTTP POST request to the /v1/creditmemos/{creditMemoId}/files endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Credit Memo Id | The ID of the credit memo that you want to upload a PDF file for. For example, 402890555a7e9791015a879f064a0054.  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of 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 | The content of the 'File' part. | #[payload]  
File Filename | The filename of the 'File' part (just the name, do not include path).  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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 want access to this feature, submit a request to Zuora Global Support.
This operation creates a PDF file for a specified credit memo. To access the generated PDF file, you can download it by clicking **View PDF** on the detailed credit memo page through the Zuora UI. This REST API operation can be used only if you have the Billing user permission "Regenerate PDF" enabled.
This operation makes an HTTP POST request to the /v1/creditmemos/{creditMemoId}/pdfs endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Credit Memo Id | The unique ID of the credit memo that you want to create a PDF file for. For example, 8a8082e65b27f6c3015ba45ff82c7172.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of 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 | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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
| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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>`
The Invoice Settlement feature is in **Limited Availability**. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request to Zuora Global Support.   
---  
This operation refunds a full or partial posted credit memo to your customers. Only the amount of unapplied part could be refunded.
You can refund a credit memo only if you have the user permission. See Billing Roles for more information.
This operation makes an HTTP POST request to the /v1/creditmemos/{creditmemoId}/refunds endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Creditmemo Id | The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of 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 | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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 want access to this feature, submit a request to Zuora Global Support.
This operation creates taxation items for a credit memo and makes an HTTP POST request to the /v1/creditmemos/{creditMemoId}/taxationitems endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Credit Memo Id | The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of 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 | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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
| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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>`
The Invoice Settlement feature is in **Limited Availability**. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request to Zuora Global Support.   
---  
This operation creates an ad-hoc debit memo from a product rate plan charge. Zuora supports the creation of debit memos from any type of product rate plan charge. The charges can also have any amount and any charge model, except for discout charge models.
You can create a debit memo only if you have the user permission. See Billing Roles for more information.
This operation makes an HTTP POST request to the /v1/debitmemos endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of 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 | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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 |  The minor version of the Zuora REST API. See Minor Version for information about REST API version control. This header affects the availability of the following request fields:
  * `charges` > `amount`
  * `charges` > `memoItemAmount`
  * `charges` > `chargeId`
  * `charges` > `productRatePlanChargeId`
  * `charges` > `comment`
  * `charges` > `description`

  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * 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 | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * 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 want access to this feature, submit a request to Zuora Global Support. Sends a posted debit memo to the specified email addresses manually.
### Notes
  * You must activate the **Email Debit Memo | Manually email Debit Memo** notification before emailing debit memos. To include the debit memo PDF in the email, select the **Include Debit Memo PDF** check box in the **Edit notification** dialog from the Zuora UI. See [Create and Edit Notifications](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/C_Create_Notifications#section_2) for more information.
  * Zuora sends the email messages based on the email template you set. You can set the email template to use in the **Delivery Options** panel of the **Edit notification** dialog from the Zuora UI. By default, the **Manual Email for Debit Memo Default Template** template is used. See [Create and Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information.
  * The debit memos are sent only to the work email addresses or personal email addresses of the Bill To contact if the following conditions are all met:
    * The `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 | The name of the configuration to use.  
Debit Memo Id | The ID of a posted debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of 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 | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS