Zuora Connector 6.0 Reference | MuleSoft Documentation
| 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


## Get revenue schedule details
`<mule-zuora-connector:get-v1-revenue-schedules-by-rs-number>`
Retrieves the details of a revenue schedule by specifying the revenue schedule number. Request and response field descriptions and sample code are provided. This operation makes an HTTP GET request to the /v1/revenue-schedules/{rs-number} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Rs number | Revenue schedule number. The revenue schedule number is always prefixed with "RS", for example, "RS-00000001".  
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


## Get revenue schedule by credit memo item ID
`<mule-zuora-connector:get-v1-revenue-schedules-credit-memo-items-by-cmi-id>`
**Note:** This feature is only available if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in **Limited Availability**. If you want access to this feature, submit a request to Zuora Global Support. Retrieves the details about a revenue schedule by specifying a valid credit memo item ID. This operation makes an HTTP GET request to the /v1/revenue-schedules/credit-memo-items/{cmi-id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
The unique ID of a credit memo item. You can get the credit memo item ID from the response of [Get credit memo items](https://www.zuora.com/developer/api-reference/#operation/GET_CreditMemoItems).  
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
| 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


## Get revenue schedule by debit memo item ID
`<mule-zuora-connector:get-v1-revenue-schedules-debit-memo-items-by-dmi-id>`
**Note:** This feature is only available if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in **Limited Availability**. If you want access to this feature, submit a request to Zuora Global Support. Retrieves the details about a revenue schedule by specifying a valid debit memo item ID. This operation makes an HTTP GET request to the /v1/revenue-schedules/debit-memo-items/{dmi-id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
The unique ID of a debit memo item. You can get the debit memo item ID from the response of [Get debit memo items](https://www.zuora.com/developer/api-reference/#operation/GET_DebitMemoItems).  
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


## Get revenue schedule by invoice item adjustment
`<mule-zuora-connector:get-v1-revenue-schedules-invoice-item-adjustments-by-invoice-item-adj-key>`
Retrieves the details of a revenue schedule by specifying a valid invoice item adjustment identifier. Request and response field descriptions and sample code are provided. This operation makes an HTTP GET request to the /v1/revenue-schedules/invoice-item-adjustments/{invoice-item-adj-key} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Invoice item adj key | ID of the Invoice Item Adjustment, for example, e20b07fd416dcfcf0141c81164fd0a72.  
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
| 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


## Get revenue schedule by invoice item ID
`<mule-zuora-connector:get-v1-revenue-schedules-invoice-items-by-invoice-item-id>`
Retrieves the details of a revenue schedule by specifying the invoice item ID. This operation makes an HTTP GET request to the /v1/revenue-schedules/invoice-items/{invoice-item-id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Invoice item id | A valid Invoice Item 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.  
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


## Get all revenue schedules of product charge by charge ID and billing
`<mule-zuora-connector:get-v1-revenue-schedules-product-charges-by-charge-key-account-key>`
**Note:** This feature is only available if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in **Limited Availability**. If you want access to this feature, submit a request to Zuora Global Support. Retrieves the details about all revenue schedules of a product rate plan charge by specifying the charge ID and billing account ID. This operation makes an HTTP GET request to the /v1/revenue-schedules/product-charges/{charge-key}/{account-key} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account key | The account number or account ID.  
Charge key | The unique ID of a product rate plan charge. For example, 8a8082e65ba86084015bb323d3c61d82.  
Page Size | Number of rows returned per page.  
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.  
Initial Page Number | The initial page to get in the first request  
Output Mime Type | The mime type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

| 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
Array of Any  
---  
### 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
Array of Any  
---  
### 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:SERVER_ERROR
  * MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
  * MULE-ZUORA-CONNECTOR:TIMEOUT
  * MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
  * MULE-ZUORA-CONNECTOR:UNAUTHORIZED
  * MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE


## Get revenue schedule by subscription charge
`<mule-zuora-connector:get-v1-revenue-schedules-subscription-charges-by-charge-key>`
Retrieves the revenue schedule details by specifying subscription charge ID. Request and response field descriptions and sample code are provided This operation makes an HTTP GET request to the /v1/revenue-schedules/subscription-charges/{charge-key} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Charge key | ID of the subscription rate plan charge; for example, 402892793e173340013e173b81000012.  
Page Size | Number of rows returned per page.  
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.  
Initial Page Number | The initial page to get in the first request  
Output Mime Type | The mime type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

| 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
Array of Any  
---  
### 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:SERVER_ERROR
  * MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
  * MULE-ZUORA-CONNECTOR:TIMEOUT
  * MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
  * MULE-ZUORA-CONNECTOR:UNAUTHORIZED
  * MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE


## Get sequence sets
`<mule-zuora-connector:get-v1-sequence-sets>`
Retrieves information about all sequence sets configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos. You can use query parameters to restrict the data returned in the response. **Note** : The Credit and Debit Memos feature is only available if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in Limited Availability. If you want access to this feature, submit a request to Zuora Global Support. This operation makes an HTTP GET request to the /v1/sequence-sets endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Page Size | Number of rows returned per page.  
The name of a specific sequence set.  
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 (`'`).  
Initial Page Number | The initial page to get in the first request  
Output Mime Type | The mime type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

| 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
Array of Any  
---  
### 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
Array of Any  
---  
### 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:SERVER_ERROR
  * MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
  * MULE-ZUORA-CONNECTOR:TIMEOUT
  * MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
  * MULE-ZUORA-CONNECTOR:UNAUTHORIZED
  * MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE


## Get sequence set
`<mule-zuora-connector:get-v1-sequence-sets-by-id>`
Retrieves information about a specific sequence set configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos **Note** : The Credit and Debit Memos feature is only available if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in Limited Availability. If you want access to this feature, submit a request to Zuora Global Support. This operation makes an HTTP GET request to the /v1/sequence-sets/{id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
The ID of the sequence set to retrieve information about.  
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 (`'`).  
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


## Get the revenue automation start date
`<mule-zuora-connector:get-v1-settings-finance-revenue-automation-start-date>`
This REST API reference describes how to get the revenue automation start date. Request and response field descriptions and sample code are provided. This operation makes an HTTP GET request to the /v1/settings/finance/revenue-automation-start-date endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | 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.  
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


## Get subscriptions by account
`<mule-zuora-connector:get-v1-subscriptions-accounts-by-account-key>`
Retrieves all subscriptions associated with the specified account. Zuora only returns the latest version of the subscriptions. Subscription data is returned in reverse chronological order based on `updatedDate`. This operation makes an HTTP GET request to the /v1/subscriptions/accounts/{account-key} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account key | Possible values are: * an account number * an account ID  
Page Size | Number of rows returned per page.  
Charge detail | The segmented rate plan charges. When an amendment results in a change to a charge, Zuora creates a segmented rate plan charge. Use this field to track segment charges. Possible values are: * _last-segment_ : (Default) The last rate plan charge on the subscription. The last rate plan charge is the last one in the order of time on the subscription rather than the most recent changed charge on the subscription. * _current-segment_ : The segmented charge that is active on today’s date (effectiveStartDate <= today’s date < effectiveEndDate). * _all-segments_ : All the segmented charges. The `chargeSegments` field is returned in the response. The `chargeSegments` field contains an array of the charge information for all the charge segments. * _specific-segment &as-of-date=date_: The segmented charge that is active on a date you specified (effectiveStartDate <= specific date < effectiveEndDate). The format of the date is yyyy-mm-dd.  
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.  
Initial Page Number | The initial page to get in the first request  
Output Mime Type | The mime type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

| 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
Array of Any  
---  
### 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:SERVER_ERROR
  * MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
  * MULE-ZUORA-CONNECTOR:TIMEOUT
  * MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
  * MULE-ZUORA-CONNECTOR:UNAUTHORIZED
  * MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE


## Get subscriptions by key
`<mule-zuora-connector:get-v1-subscriptions-by-subscription-key>`
This REST API reference describes how to retrieve detailed information about a specified subscription in the latest version. This operation makes an HTTP GET request to the /v1/subscriptions/{subscription-key} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Subscription key | Possible values are: * a subscription number * a subscription ID  
Charge detail | The segmented rate plan charges. When an amendment results in a change to a charge, Zuora creates a segmented rate plan charge. Use this field to track segment charges. Possible values are: * _last-segment_ : (Default) The last rate plan charge on the subscription. The last rate plan charge is the last one in the order of time on the subscription rather than the most recent changed charge on the subscription. * _current-segment_ : The segmented charge that is active on today’s date (effectiveStartDate <= today’s date < effectiveEndDate). * _all-segments_ : All the segmented charges. The `chargeSegments` field is returned in the response. The `chargeSegments` field contains an array of the charge information for all the charge segments. * _specific-segment &as-of-date=date_: The segmented charge that is active on a date you specified specific date = effectiveStartDate) OR (effectiveStartDate < specific date < effectiveEndDate. The format of the date is yyyy-mm-dd.  
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


## Get subscriptions by key and version
`<mule-zuora-connector:get-v1-subscriptions-versions-by-subscription-key-version>`
This REST API reference describes how to retrieve detailed information about a specified subscription in a specified version. When you create a subscription amendment, you create a new version of the subscription. You can use this method to retrieve information about a subscription in any version. This operation makes an HTTP GET request to the /v1/subscriptions/{subscription-key}/versions/{version} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Subscription key | Subscription number. For example, A-S00000135.  
Subscription version. For example, 1.  
Charge detail | The segmented rate plan charges. When an amendment results in a change to a charge, Zuora creates a segmented rate plan charge. Use this field to track segment charges. Possible values are: * _last-segment_ : (Default) The last rate plan charge on the subscription. The last rate plan charge is the last one in the order of time on the subscription rather than the most recent changed charge on the subscription. * _current-segment_ : The segmented charge that is active on today’s date (effectiveStartDate <= today’s date < effectiveEndDate). * _all-segments_ : All the segmented charges. The `chargeSegments` field is returned in the response. The `chargeSegments` field contains an array of the charge information for all the charge segments. * _specific-segment &as-of-date=date_: The segmented charge that is active on a date you specified (effectiveStartDate <= specific date < effectiveEndDate). The format of the date is yyyy-mm-dd.  
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


## Get taxation item
`<mule-zuora-connector:get-v1-taxationitems-by-id>`
Retrieves the information about a specific taxation item by ID. This operation makes an HTTP GET request to the /v1/taxationitems/{id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
The unique ID of a taxation item.  
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
| 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


## Get invoices
`<mule-zuora-connector:get-v1-transactions-invoices-accounts-by-account-key>`
Retrieves invoices for a specified account. Invoices are returned in reverse chronological order by **updatedDate**. This operation makes an HTTP GET request to the /v1/transactions/invoices/accounts/{account-key} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account key | Account number or account ID.  
Page Size | Number of rows returned per page.  
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.  
Initial Page Number | The initial page to get in the first request  
Output Mime Type | The mime type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

| 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
Array of Any  
---  
### 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:SERVER_ERROR
  * MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
  * MULE-ZUORA-CONNECTOR:TIMEOUT
  * MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
  * MULE-ZUORA-CONNECTOR:UNAUTHORIZED
  * MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE


## Get payments
`<mule-zuora-connector:get-v1-transactions-payments-accounts-by-account-key>`
Retrieves payments for a specified account. Payments are returned in reverse chronological order by **updatedDate**. This operation makes an HTTP GET request to the /v1/transactions/payments/accounts/{account-key} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account key | Account number or account ID.  
Page Size | Number of rows returned per page.  
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.  
Initial Page Number | The initial page to get in the first request  
Output Mime Type | The mime type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

| 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
Array of Any  
---  
### 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
Array of Any  
---  
### 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:SERVER_ERROR
  * MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
  * MULE-ZUORA-CONNECTOR:TIMEOUT
  * MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
  * MULE-ZUORA-CONNECTOR:UNAUTHORIZED
  * MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE


## Get usage
`<mule-zuora-connector:get-v1-usage-accounts-by-account-key>`
This REST API reference describes how to retrieve usage details for an account. Usage data is returned in reverse chronological order. This operation makes an HTTP GET request to the /v1/usage/accounts/{account-key} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account key | Account number or account ID.  
Page Size | Number of rows returned per page.  
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.  
Initial Page Number | The initial page to get in the first request  
Output Mime Type | The mime type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

| 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
Array of Any  
---  
### 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:SERVER_ERROR
  * MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
  * MULE-ZUORA-CONNECTOR:TIMEOUT
  * MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
  * MULE-ZUORA-CONNECTOR:UNAUTHORIZED
  * MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE


## Multi-entity: Get entities that a user can access
`<mule-zuora-connector:get-v1-users-accessible-entities-by-username>`
**Note:** The Multi-entity feature is in **Limited Availability**. If you want access to this feature, submit a request to Zuora Global Support. Retrieves detailed information about all the entities that a user has permission to access. ## User Access Permission You can make the call as any entity user. This operation makes an HTTP GET request to the /v1/users/{username}/accessible-entities endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
username | Specify the login user name that you want to retrieve.  
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
| 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


## Get workflows
`<mule-zuora-connector:get-workflows>`
Retrieves a list of workflows available in your Zuora tenant. This operation makes an HTTP GET request to the /workflows endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
If specified, the operation retrieves the workflow that is in the specified name.  
Callout trigger | If set to true, the operation retrieves workflows that have the callout trigger enabled. If set to false, the operation retrieves workflows that have the callout trigger disabled. If not specified, the operation will not use this filter.  
If you want to retrieve only the workflows on a specific page, you can specify the `page` number in the query.  
interval | A CRON expession that specifies a schedule (for example, `0 0 * * *`). If specified, the operation retrieves the workflow that is run based on the specified schedule.  
Ondemand trigger | If set to true, the operation retrieves workflows that have the ondemand trigger enabled. If set to false, the operation retrieves workflows that have the ondemand trigger disabled. If not specified, the operation will not use this filter.  
Page length | The number of workflows shown in a single call. If the `page` parameter is not specified, the operation will return only the first page of results. If there are multiple pages of results, use it with the `page` parameter to get the results on subsequent pages.  
Scheduled trigger | If set to true, the operation retrieves workflows that have the scheduled trigger enabled. If set to false, the operation retrieves workflows that have the scheduled trigger disabled. If not specfied, the operation will not use this filter.  
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 (`'`).  
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


## Get a workflow by ID
`<mule-zuora-connector:get-workflows-by-workflow-id>`
Retrieves information about a specific workflow by its ID. This operation makes an HTTP GET request to the /workflows/{workflow_id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Workflow id | The unique ID of a workflow. For example, 19080.  
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 (`'`).  
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


## Export a workflow
`<mule-zuora-connector:get-workflows-export-by-workflow-id>`
Export a Workflow in a JSON document. This document can be used to create a copy of this workflow. This operation makes an HTTP GET request to the /workflows/{workflow_id}/export endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Workflow id | The ID of the workflow to export.  
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 (`'`).  
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


## Get workflow task usage
`<mule-zuora-connector:get-workflows-metricsjson>`
Gets workflow task usage sorted by day within a specified time frame. This operation makes an HTTP GET request to the /workflows/metrics.json endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Start Date | The start date of the usage data that you want to get. For example, 2019-01-01.  
End Date | The end date of the usage data that you want to get. For example, 2019-12-31.  
The type of metric that you want to get. Currently, only `taskCount` is supported. `taskCount` is the amount of task runs.  
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 (`'`).  
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


## Get tasks
`<mule-zuora-connector:get-workflows-tasks>`
Retrieves a list of workflow tasks available in your Zuora tenant. This operation makes an HTTP GET request to the /workflows/tasks endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Retrieves tasks that are in the specified name  
Call type | Retrieves tasks with the specified API call type used  
Retrieves tasks that have the specified filter tags  
To retrieve only the workflows on a specific page, you can specify the `page` number in the query.  
instance | If set to true, the operation retrieves workflows that have the scheduled trigger enabled. If set to false, the operation retrieves workflows that have the scheduled trigger disabled. If not specfied, the operation does not use this filter.  
Retrieves tasks with the specified object  
Retrieves the task with the specified ID  
Workflow id | Retrieves tasks for the specified workflow ID  
Page length | The number of workflows shown in a single call. If the `page` parameter is not specified, the operation returns only the first page of results. If there are multiple pages of results, use it with the `page` parameter to get the results on subsequent pages.  
Action type | Retrieves tasks with the specified type  
Object id | Retrieves tasks with the specified object ID  
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 in the event of 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 (`'`).  
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


## Get a task by ID
`<mule-zuora-connector:get-workflows-tasks-by-task-id>`
Retrieves a specific workflow task by its ID. This operation makes an HTTP GET request to the /workflows/tasks/{task_id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
The unique ID of the task.  
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 (`'`).  
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


## Update individual fields in a custom object record
`<mule-zuora-connector:patch-objects-records-default-by-object-id>`
Updates one or many fields of a custom object record. Patch update uses JSON Merge Patch as specified in RFC 7386.
### Limitations
  * The storage of empty strings in records is not supported.
  * Null values must be formatted as the following example: ` { "records": [ { "fieldName__c": null } ] } `


This operation makes an HTTP PATCH request to the /objects/records/default/{object}/{id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Specifies the custom object''s API name as object. It is case-sensitive.  
Id identifier in uuid form  
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.  
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

| Configures 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 an Event Trigger
`<mule-zuora-connector:update-events-event-triggers-by-id>`
Updates an event trigger. This operation makes an HTTP PUT request to the /events/event-triggers/{id} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | 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


## Update an email template
`<mule-zuora-connector:update-notifications-email-templates-by-id>`
Updates an email template. This operation makes an HTTP PUT request to the /notifications/email-templates/{id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
The ID of the email template to be updated.  
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](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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


## Update a notification definition
`<mule-zuora-connector:update-notifications-notification-definitions-by-id>`
Updates a notification definition. This operation makes an HTTP PUT request to the /notifications/notification-definitions/{id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
The ID of the notification definition to be updated.  
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](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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


## Update custom object record
`<mule-zuora-connector:update-objects-records-default-by-object-id>`
Update a record of the given type and id. ## Limitations * The storage of empty strings in records is not supported. * Null values must be formatted as the following example: ` { "records": [ { "fieldName__c": null } ] } ` This operation makes an HTTP PUT request to the /objects/records/default/{object}/{id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Specifies the custom object''s API name as object. It is case-sensitive.  
Id identifier in uuid form  
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 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 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.  
If Match | The expected ETag of the resource. You can use this header to perform a conditional request. Zuora responds with 412 Precondition Failed if the ETag of the resource does not match the value of this header.  
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


## Activate accounting code
`<mule-zuora-connector:update-v1-accounting-codes-activate-by-ac-id>`
This reference describes how to activate an accounting code through the REST API. Prerequisites ------------- If you have Zuora Finance enabled on your tenant, you must have the Manage Accounting Code permission. This operation makes an HTTP PUT request to the /v1/accounting-codes/{ac-id}/activate endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
ID of the accounting code you want to activate.  
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


## Update an accounting code
`<mule-zuora-connector:update-v1-accounting-codes-by-ac-id>`
This reference describes how to update an existing accounting code through the REST API.  Prerequisites If you have Zuora Finance enabled on your tenant, you must have the Manage Accounting Code permission.  Limitations You can only update accounting codes that are not already associated with any transactions. This operation makes an HTTP PUT request to the /v1/accounting-codes/{ac-id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
ID of the accounting code you want to update.  
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


## Deactivate accounting code
`<mule-zuora-connector:update-v1-accounting-codes-deactivate-by-ac-id>`
This reference describes how to deactivate an accounting code through the REST API.
### Before You Begin
If you have Zuora Finance enabled on your tenant, you must have the Manage Accounting Code permission.
### Limitations
You can only deactivate accounting codes that are not associated with any transactions. You cannot disable accounting codes of type AccountsReceivable.
This operation makes an HTTP PUT request to the /v1/accounting-codes/{ac-id}/deactivate endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
ID of the accounting code you want to deactivate.  
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


## Update accounting period
`<mule-zuora-connector:update-v1-accounting-periods-by-ap-id>`
Updates an accounting period. This operation makes an HTTP PUT request to the /v1/accounting-periods/{ap-id} endpoint.
### Before You Begin
  * You must have Zuora Finance enabled on your tenant.
  * You must have the Create Accounting Period user permission. See [Finance Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/f_Finance_Roles).
## Update accounting period
`<mule-zuora-connector:update-v1-accounting-periods-by-ap-id>`
Updates an accounting period. This operation makes an HTTP PUT request to the /v1/accounting-periods/{ap-id} endpoint.
### Before You Begin
  * You must have Zuora Finance enabled on your tenant.
  * You must have the Create Accounting Period user permission. See [Finance Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/f_Finance_Roles).


### Limitations
  * You can update the start date of only the earliest accounting period on your tenant.
  * You cannot update the start date of later periods. * If you update the earliest accounting period, the start date must be equal to or earlier than the date of the earliest transaction on the tenant.
  * Start and end dates of accounting periods must be contiguous. For example, if one accounting period ends on January 31, the next period must start on February 1.
  * If you have the Revenue Recognition Package and have enabled the "Monthly recognition over time" revenue recognition model, the accounting period start date and end date must be on the first day and last day of the month, respectively. Note that the start and end dates do not necessarily have to be in the same month.
  * You cannot update the start date or end date of an accounting period if:
    * Any revenue has been distributed into the period.
    * The period has any active journal entries.


### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
ID of the accounting period you want to update.  
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


## Close accounting period
`<mule-zuora-connector:update-v1-accounting-periods-close-by-ap-id>`
Close an accounting period by accounting period ID. This operation makes an HTTP PUT request to the /v1/accounting-periods/{ap-id}/close endpoint
### Before You Begin
  * You must have Zuora Finance enabled on your tenant.
  * You must have the Manage Close Process and Run Trial Balance user permissions.


### Limitations
  * The accounting period cannot already be closed.
  * The accounting period cannot be in the process of running a trial balance.
  * All earlier accounting periods must be closed.
  * There must be no required action items for the accounting period. See Reconcile Transactions Before Closing an Accounting Period for more information.


### Notes
When you close an accounting period in Zuora, a trial balance is automatically run for that period. A successful response means only that the accounting period is now closed, but does not mean that the trial balance has successfully completed.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
ID of the accounting period you want to close.  
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


## Set accounting period to pending close
`<mule-zuora-connector:update-v1-accounting-periods-pending-close-by-ap-id>`
Sets an accounting period to pending close. This operation makes an HTTP PUT request to the /v1/accounting-periods/{ap-id}/pending-close endpoint
### Before You Begin
  * You must have Zuora Finance enabled on your tenant.
  * You must have the Manage Close Process and Run Trial Balance user permissions.


### Limitations
  * The accounting period cannot be closed or pending close.
  * The accounting period cannot be in the process of running a trial balance.
  * All earlier accounting periods must be closed.


### Notes
When you set an accounting period to pending close in Zuora, a trial balance is automatically run for that period. A response of `{ "success": true }` means only that the accounting period status is now pending close, but does not mean that the trial balance has successfully completed.
You can use the Get Accounting Period REST API call to view details about the outcome of the trial balance.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
ID of the accounting period you want to set to pending close.  
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


## Re-open accounting period
`<mule-zuora-connector:update-v1-accounting-periods-reopen-by-ap-id>`
Reopens an accounting period. This operation makes an HTTP PUT request to the /v1/accounting-periods/{ap-id}/reopen endpoint.
### Before You Begin
  * You must have Zuora Finance enabled on your tenant.
  * You must have the Manage Close Process and Run Trial Balance user permissions.


### Limitations
  * The accounting period must be closed or pending close.
  * You can only re-open an accounting period that is immediately previous to an open period.


### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
ID of the accounting period that you want to re-open.  
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


## Run Trial Balance
`<mule-zuora-connector:update-v1-accounting-periods-run-trial-balance-by-ap-id>`
Runs the trial balance for an accounting period. This operation makes an HTTP PUT request to the /v1/accounting-periods/{ap-id}/run-trial-balance endpoint
### Before You Begin
  * You must have Zuora Finance enabled on your tenant.
  * You must have the Manage Close Process and Run Trial Balance user permissions. See [Finance Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/f_Finance_Roles).


### Limitations
  * The accounting period must be open.
  * The accounting period cannot already be in the process of running a trial balance.


### Notes
The trial balance is run asynchronously. A response of `{ "success": true }` means only that the trial balance has started processing, but does not mean that the trial balance has successfully completed.
You can use the [Get Accounting Period](https://www.zuora.com/developer/api-reference/#operation/GET_AccountingPeriod) REST API call to view details about the outcome of the trial balance.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
ID of the accounting period for which you want to run a trial balance.  
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


## Update account
`<mule-zuora-connector:update-v1-accounts-by-account-key>`
Updates a customer account by specifying the account-key.
### Notes
  1. Only the fields to be changed should be specified. Any field that is not included in the request body will not be changed.
  2. If an empty field is submitted with this operation, the corresponding field in the account is emptied.
  3. Email addresses: If no email addresses are specified, no change is made to the email addresses on file or to the email delivery preference. If either the **personalEmail** or **workEmail** is specified (or both), the system updates the corresponding email address(es) on file and the email delivery preference is set to `true`. (In that case, emails go to the **workEmail** address, if it exists, or else the **personalEmail**.) On the other hand, if as a result of this call both of the email addresses for the account are empty, the email delivery preference is set to `false`.
  4. The bill-to and sold-to contacts are separate data entities; updating either one does not update the other. This operation makes an HTTP PUT request to the /v1/accounts/{account-key} endpoint


### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account key | Account number or account 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.  
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


## Edit Attachments
`<mule-zuora-connector:update-v1-attachments-by-attachment-id>`
Use the Edit Attachment REST request to make changes to the descriptive fields of an attachment, such as the description and the file name.
You cannot change the actual content of the attached file in Zuora. If you need to change the actual content, you need to delete the attachment and add the updated file as a new attachment.
This operation makes an HTTP PUT request to the /v1/attachments/{attachment-id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Attachment id | Id of the attachment to be updated.  
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


## Stop Mass Action
`<mule-zuora-connector:update-v1-bulk-stop-by-bulk-key>`
This reference describes how to stop a mass action through the REST API.
You can stop a mass action when its status is Pending or Processing. After you have stopped a mass action, you can get the mass action result to see details of the mass action.
  * If you stop a mass action when its status is Pending, no response file is generated because no records have been processed.
  * If you stop a mass action when its status is Processing, a response file is generated.


You can check the response file to see which records have been processed and which have not. In the response file, the **Success** column has the value `Y` (successful) or `N` (failed) for processed records, and a blank value for unprocessed records. Records that have already been processed when a mass action is stopped are not rolled back.
This operation makes an HTTP PUT request to the /v1/bulk/{bulk-key}/stop endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Bulk key | String of 32 characters that identifies a mass action. You get the bulk-key after performing a mass action through the REST API.  
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
| 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


## Scrub Contact
`<mule-zuora-connector:update-v1-contacts-scrub-by-contact-id>`
Scrubs the sensitive data of a specific contact.
You can use this operation to replace all sensitive data in a contact and its related contact snapshot with dummy values that will be stored in Zuora databases. After scrubbing a contact, it is good practice to delete it. Otherwise, it might cause errors in subsequent operations.
**Note** : To use this operation, you must ensure that the "Scrub Sensitive Data of Contact" billing permission is enabled in your user role. Contact your tenant administrator if you want to enable this permission. See [Scrub Contacts](https://knowledgecenter.zuora.com/BC_Subscription_Management/Customer_Accounts/A_How_to_Manage_Customer_Accounts/B_Key_Contacts/Scrub_Contacts) for more information.
This operation makes an HTTP PUT request to the /v1/contacts/{contactId}/scrub endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Contact Id | The ID of the contact that you want to scrub sensitive data from.  
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 (`'`).  
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


## Apply Credit Memo
`<mule-zuora-connector:update-v1-creditmemos-apply-by-credit-memo-id>`
**Note:** The Invoice Settlement feature is in **Limited Availability**. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to the feature, submit a request to Zuora Global Support. Applies a posted credit memo to one or more invoices and debit memos.
You can apply a credit memo to an invoice or a debit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. When applying a credit memo, the total number of invoices and debit memos that the credit memo will apply to must be less than or equal to 1,000. If the Proration application rule is used, when applying credit memos, the following quantity must be less than or equal to 10,000: (number of invoice items + number of debit memo items) * number of credit memo items Otherwise, the First In First Out rule will be used instead of the Proration rule.
This operation makes an HTTP PUT request to the /v1/creditmemos/{creditMemoId}/apply endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | 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


## Update Credit Memo
`<mule-zuora-connector:update-v1-creditmemos-by-credit-memo-id>`
**Note:** The Invoice Settlement feature is in **Limited Availability**. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you wish to have access to the feature, submit a request to Zuora Global Support. Updates the basic and finance information about a credit memo. Currently, Zuora supports updating tax-exclusive memo items, but does not support updating tax-inclusive memo items.
If the amount of a memo item is updated, the tax will be recalculated in the following conditions:
  * The memo is created from a product rate plan charge and you use Avalara to calculate the tax. * The memo is created from an invoice and you use Avalara or Zuora Tax to calculate the tax.


You can update a credit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.
This operation makes an HTTP PUT request to the /v1/creditmemos/{creditMemoId} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | 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


## Cancel Credit Memo
`<mule-zuora-connector:update-v1-creditmemos-cancel-by-credit-memo-id>`
The Invoice Settlement feature is in **Limited Availability**. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request to Zuora Global Support.
Cancels a credit memo. Only credit memos with the Draft status can be cancelled.
You can cancel a credit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.
This operation makes an HTTP PUT request to the /v1/creditmemos/{creditMemoId}/cancel endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | 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.  
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


## Post credit memo
`<mule-zuora-connector:update-v1-creditmemos-post-by-credit-memo-id>`
**Note:** The Invoice Settlement feature is in **Limited Availability**. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request to Zuora Global Support.
Posts a credit memo to activate it.
You can post credit memos only if you have the Billing permissions.
This operation makes an HTTP PUT request to the /v1/creditmemos/{creditMemoId}/post endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | 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.  
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


## Unapply credit memo
`<mule-zuora-connector:update-v1-creditmemos-unapply-by-credit-memo-id>`
**Note:** The Invoice Settlement feature is in **Limited Availability**. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request to Zuora Global Support. Unapplies an applied credit memo from one or more invoices and debit memos. The full applied amount from invoices and debit memos is transferred into the unapplied amount of the credit memo. You can unapply a credit memo from an invoice or a debit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. When unapplying a credit memo, the total number of invoices and debit memos that the credit memo will be unapplied from must be less than or equal to 1,000. If the Proration application rule is used, when unapplying credit memos, the following quantity must be less than or equal to 10,000: (number of invoice items + number of debit memo items) * number of credit memo items Otherwise, the First In First Out rule will be used instead of the Proration rule. This operation makes an HTTP PUT request to the /v1/creditmemos/{creditMemoId}/unapply endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | 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
| 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


## Unpost credit memo
`<mule-zuora-connector:update-v1-creditmemos-unpost-by-credit-memo-id>`
**Note:** The Invoice Settlement feature is in **Limited Availability**. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request to Zuora Global Support. Unposts a credit memo that is in Posted status. If a credit memo has been applied or refunded, you are not allowed to unpost it. After a credit memo is unposted, its status becomes Draft. You can unpost credit memos only if you have the [Billing permissions](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles#Billing_Permissions). This operation makes an HTTP PUT request to the /v1/creditmemos/{creditMemoId}/unpost endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | 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.  
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


## PUT Batch Update Debit Memos
`<mule-zuora-connector:update-v1-debitmemos>`
**Note:** The Invoice Settlement feature is in **Limited Availability**. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request to Zuora Global Support. Updates the due date for multiple debit memos in batches with one call. This operation makes an HTTP PUT request to the /v1/debitmemos endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | 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