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


## CRUD: Delete TaxationItem
`<mule-zuora-connector:delete-v1-object-taxation-item-by-id>`
CRUD: Delete TaxationItem This operation makes an HTTP DELETE request to the /v1/object/taxation-item/{id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Object id  
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


## CRUD: Delete UnitOfMeasure
`<mule-zuora-connector:delete-v1-object-unit-of-measure-by-id>`
CRUD: Delete UnitOfMeasure This operation makes an HTTP DELETE request to the /v1/object/unit-of-measure/{id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Object id  
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


## CRUD: Delete usage
`<mule-zuora-connector:delete-v1-object-usage-by-id>`
CRUD: Delete usage This operation makes an HTTP DELETE request to the /v1/object/usage/{id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Object id  
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


## Delete Order
`<mule-zuora-connector:delete-v1-orders-by-order-number>`
This operation deletes a specified order. All the subscriptions changed by this order are deleted. After the deletion, the subscriptions are rolled back to the previous version. You are not allowed to delete an order if the charges that are affected by this order are invoiced. This operation makes an HTTP DELETE request to the /v1/orders/{orderNumber} endpoint.
**Note:** This operation is only available if you have the Orders feature enabled.
The migration to Orders is in **Limited Availability**. Feedback is being actively solicited from a small set of early adopters before releasing as generally available.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Order Number | The number of the order to be deleted.  
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


## Delete payment method
`<mule-zuora-connector:delete-v1-payment-methods-by-payment-method-id>`
Deletes a credit card payment method from the specified customer account. If the specified payment method is the account’s default payment method, the request fails. In that case, you must first designate a different payment method for that customer to be the default. This operation makes an HTTP DELETE request to the /v1/payment-methods/{payment-method-id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Payment method id | Unique identifier of a payment method. (Since this ID is unique, and linked to a customer account in the system, no customer identifier is needed.)  
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


## Delete payment run
`<mule-zuora-connector:delete-v1-payment-runs-by-payment-run-id>`
Deletes a payment run. Only payment runs with the Canceled or Error status can be deleted. This operation makes an HTTP DELETE request to the /v1/payment-runs/{paymentRunId} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Payment Run Id | The unique ID of a payment run. For example, 402890245f097f39015f0f074a2e0566.  
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


## Delete payment
`<mule-zuora-connector:delete-v1-payments-by-payment-id>`
**Note:** The Invoice Settlement feature is in **Limited Availability**. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request to Zuora Global Support. Deletes a payment. Only payments with the Cancelled status can be deleted. If you have the Invoice Settlement feature enabled, overpayments applied to credit balance cannot be deleted. This operation makes an HTTP DELETE request to the /v1/payments/{paymentId} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Payment Id | The unique ID of an unapplied payment. For example, 8a8082e65b27f6c3015b89e4344c16b1.  
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


## Delete refund
`<mule-zuora-connector:delete-v1-refunds-by-refund-id>`
**Note:** This feature is only available if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in **Limited Availability**. If you want access to this feature, submit a request to Zuora Global Support. Deletes a refund. You can delete a refund with the Canceled or Error status. If you have the Invoice Settlement feature enabled, refunds applied to credit balance cannot be deleted. This operation makes an HTTP DELETE request to the /v1/refunds/{refundId} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Refund Id | The unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9.  
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


## Delete revenue schedule
`<mule-zuora-connector:delete-v1-revenue-schedules-by-rs-number>`
Deletes a revenue schedule by specifying its revenue schedule number ## Prerequisites You must have the Delete Custom Revenue Schedule permissions in Zuora Finance. This operation makes an HTTP DELETE request to the /v1/revenue-schedules/{rs-number} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Rs number | Revenue schedule number of the revenue schedule you want to delete, for example, RS-00000256. To be deleted, the revenue schedule: * Must be using a custom unlimited recognition rule. * Cannot have any revenue in a closed accounting period. * Cannot be included in a summary journal entry. * Cannot have a revenue schedule date in a closed accounting period.  
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


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


## Delete taxation item
`<mule-zuora-connector:delete-v1-taxationitems-by-id>`
Deletes a specific taxation item by ID. This operation makes an HTTP DELETE request to the /v1/taxationitems/{id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | 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

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * Configurations


### Throws
  * MULE-ZUORA-CONNECTOR:BAD_REQUEST
  * MULE-ZUORA-CONNECTOR:CLIENT_ERROR
  * MULE-ZUORA-CONNECTOR:CONNECTIVITY
  * MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
  * MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
  * MULE-ZUORA-CONNECTOR:NOT_FOUND
  * MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
  * MULE-ZUORA-CONNECTOR:SERVER_ERROR
  * MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
  * MULE-ZUORA-CONNECTOR:TIMEOUT
  * MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
  * MULE-ZUORA-CONNECTOR:UNAUTHORIZED
  * MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE


## Delete a workflow by ID
`<mule-zuora-connector:delete-workflows-by-workflow-id>`
Deletes a specific workflow by its ID. This operation makes an HTTP DELETE request to the /workflows/{workflow_id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | 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

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * Configurations


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


### Throws
  * MULE-ZUORA-CONNECTOR:BAD_REQUEST
  * MULE-ZUORA-CONNECTOR:CLIENT_ERROR
  * MULE-ZUORA-CONNECTOR:CONNECTIVITY
  * MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
  * MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
  * MULE-ZUORA-CONNECTOR:NOT_FOUND
  * MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
  * MULE-ZUORA-CONNECTOR:SERVER_ERROR
  * MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
  * MULE-ZUORA-CONNECTOR:TIMEOUT
  * MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
  * MULE-ZUORA-CONNECTOR:UNAUTHORIZED
  * MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE


## Query event triggers
`<mule-zuora-connector:get-events-event-triggers>`
Query event triggers This operation makes an HTTP GET request to the /events/event-triggers endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Event Type Name | The event type name. Should be specified in the pattern: ^[A-Za-z]{1,}[\w\\-]*$  
Base Object | The Zuora object that trigger condition is defined upon. Should be specified in the pattern: ^[A-Z][\\\w\\\\-]*$  
The first index of the query result. Default to 0 if absent, and the minimum is 0.  
The maximum number of data records to be returned. Default to 10 if absent.  
The status of the event trigger.  
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 an event trigger by ID
`<mule-zuora-connector:get-events-event-triggers-by-id>`
Get an event trigger by ID This operation makes an HTTP GET request to the /events/event-triggers/{id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | 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 (`'`).  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * Configurations


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


### Throws
  * MULE-ZUORA-CONNECTOR:BAD_REQUEST
  * MULE-ZUORA-CONNECTOR:CLIENT_ERROR
  * MULE-ZUORA-CONNECTOR:CONNECTIVITY
  * MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
  * MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
  * MULE-ZUORA-CONNECTOR:NOT_FOUND
  * MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
  * MULE-ZUORA-CONNECTOR:SERVER_ERROR
  * MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
  * MULE-ZUORA-CONNECTOR:TIMEOUT
  * MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
  * MULE-ZUORA-CONNECTOR:UNAUTHORIZED
  * MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE


## Query email templates
`<mule-zuora-connector:get-notifications-email-templates>`
Queries email templates. This operation makes an HTTP GET request to the /notifications/email-templates endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
The first index of the query result.  
The maximum number of results the query should return.  
Event Type Name | The name of the event.  
The name of the email template.  
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.  
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 an email template
`<mule-zuora-connector:get-notifications-email-templates-by-id>`
Queries the email template of the specified ID. This operation makes an HTTP GET request to the /notifications/email-templates/{id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
The ID of the email template.  
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.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * Configurations


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


### Throws
  * MULE-ZUORA-CONNECTOR:BAD_REQUEST
  * MULE-ZUORA-CONNECTOR:CLIENT_ERROR
  * MULE-ZUORA-CONNECTOR:CONNECTIVITY
  * MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
  * MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
  * MULE-ZUORA-CONNECTOR:NOT_FOUND
  * MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
  * MULE-ZUORA-CONNECTOR:SERVER_ERROR
  * MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
  * MULE-ZUORA-CONNECTOR:TIMEOUT
  * MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
  * MULE-ZUORA-CONNECTOR:UNAUTHORIZED
  * MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE


## Query notification definitions
`<mule-zuora-connector:get-notifications-notification-definitions>`
Queries notification definitions with the specified filters. This operation makes an HTTP GET request to the /notifications/notification-definitions endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Profile Id | Id of the profile.  
Event Type Name | The name of the event.  
The first index of the query result.  
The maximum number of results the query should return.  
Email Template Id | The ID of the email template.  
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.  
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 notification definition
`<mule-zuora-connector:get-notifications-notification-definitions-by-id>`
Queries the notification definition of the given ID. This operation makes an HTTP GET request to the /notifications/notification-definitions/{id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
The ID of the notification definition.  
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.  
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 all custom object definitions
`<mule-zuora-connector:get-objects-definitions-default>`
Get all custom object definitions This operation makes an HTTP GET request to the /objects/definitions/default endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Enumeration, one of: | If you set `select` to `type`, the response will only contain the `type` of each custom object.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
Authorization | `Bearer {token}` for a valid OAuth token.  
Zuora Version | API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in the request header if you expect a specific response schema.  
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 custom object definition
`<mule-zuora-connector:get-objects-definitions-default-by-object>`
Get the custom object definition by type for the given tenant. This operation makes an HTTP GET request to the /objects/definitions/default/{object} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Specifies the custom object''s API name as object. It is case-sensitive.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
Authorization | `Bearer {token}` for a valid OAuth token.  
Zuora Version | API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in the request header if you expect a specific response schema.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

| A time unit that qualifies the Response Timeout  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of a variable in which to store the operation’s output  
Target Value | An expression that evaluates the operation’s output. The expression outcome is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * Configurations


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


### Throws
  * MULE-ZUORA-CONNECTOR:BAD_REQUEST
  * MULE-ZUORA-CONNECTOR:CLIENT_ERROR
  * MULE-ZUORA-CONNECTOR:CONNECTIVITY
  * MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
  * MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
  * MULE-ZUORA-CONNECTOR:NOT_FOUND
  * MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
  * MULE-ZUORA-CONNECTOR:SERVER_ERROR
  * MULE-ZUORA-CONNECTOR:SERVICE_UNAVAILABLE
  * MULE-ZUORA-CONNECTOR:TIMEOUT
  * MULE-ZUORA-CONNECTOR:TOO_MANY_REQUESTS
  * MULE-ZUORA-CONNECTOR:UNAUTHORIZED
  * MULE-ZUORA-CONNECTOR:UNSUPPORTED_MEDIA_TYPE


## Query custom object records
`<mule-zuora-connector:get-objects-records-default-by-object>`
Get all object records of the given type. You can also use the `q` query parameter to filter the output records. ## Limitations This call has the following limitations: * When a record is created, there will be a delay before it is available for search. For example, if you create 5 records and perform a query that these 5 records satisfy the query conditions, there will be a delay between when the 5 records are created, and when all the 5 records can be returned in the query result. This operation makes an HTTP GET request to the /objects/records/default/{object} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Specifies the custom object''s API name as object. It is case-sensitive.  
The query string to filter the records of a custom object. See the [Query syntax of custom object records](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Data_Model/Custom_object_records/Query_syntax_of_custom_object_records) for more information.  
UUIDs of the records to be queried. For example: `GET /objects/records/default/passenger?ids=258d65b2-7bc6-4142-88bc-5184931af493&ids=82ecc9f7-b192-4f88-a4a3-4b2af6c750a1`  
Page Size | Page size. The value must be between 1 and 1000.  
The `cursor` points to the last record of the previous result set. The cursor record is not included in the query result. The call returns the first page if `cursor` is not provided and `pageSize` is valid.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
Authorization | `Bearer {token}` for a valid OAuth token.  
Zuora Version | API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in the request header if you expect a specific response schema.  
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 custom object record
`<mule-zuora-connector:get-objects-records-default-by-object-id>`
Get a record of a given type by ID. This operation makes an HTTP GET request to the /objects/records/default/{object}/{id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | 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](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token 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.  
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 data query jobs
`<mule-zuora-connector:get-query-jobs>`
Returns a list of [data query](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query) jobs that have been created in your Zuora tenant. You can filter the list by status. If you are an administrator, you can retrieve all the query jobs in your tenant. Otherwise, you can only retrieve your own query jobs. This operation makes an HTTP GET request to the /query/jobs endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Query Status |  Enumeration, one of:
  * ACCEPTED
  * IN_PROGRESS
  * COMPLETED
  * FAILED
  * CANCELLED

| Filters the list of query jobs by status.  
Page Size | Specifies the maximum number of query jobs to return.  
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 data query job
`<mule-zuora-connector:get-query-jobs-by-job-id>`
Retrieves a [data query](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query) job. You can use this operation to track the status of the query job and obtain the URL of the query results. If you are an administrator, you can retrieve every query job in your tenant. If you are a non-admin user and try to retrieve a query job that you are not the owner of, you will get a 403 response indicating that you are forbidden from viewing this job. As a non-admin user, you can only retrieve your own query job. This operation makes an HTTP GET request to the /query/jobs/{job-id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Internal identifier of the query job.  
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
| 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


## List all settings
`<mule-zuora-connector:get-settings-listing>`
Get a list of all available settings in your tenant.
The response message is in JSON format by default. If you want to receive all the availabe settings in CSV format, include `Accept` in the header parameters and set it to `application/csv`.
You can find a specific operate of an available setting item in your tenant from the 200 response body of this call.
See the following tutorials for the Settings API for how to use a specifc setting item:
  * Get a specific setting - Billing Rules
  * Update a specific setting - Billing Rules
  * Get all Communication Profiles
  * Create a new Communication Profile
  * Modify a Communication Profile
  * Get all Notifications under a particular Communication Profile
  * Get a specific Invoice Template
  *   * Create a new Invoice Template
  *   *   * 

This operation makes an HTTP GET request to the /settings/listing 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 (`'`).  
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 Accounting Codes
`<mule-zuora-connector:get-v1-accounting-codes>`
This reference describes how to query all accounting codes in your chart of accounts through the REST API. This operation makes an HTTP GET request to the /v1/accounting-codes endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
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.  
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


## Query an Accounting Code
`<mule-zuora-connector:get-v1-accounting-codes-by-ac-id>`
This reference describes how to query an accounting code through the REST API. This operation makes an HTTP GET request to the /v1/accounting-codes/{ac-id} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
ID of the accounting code you want to query.  
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 accounting periods
`<mule-zuora-connector:get-v1-accounting-periods>`
Retrieves all accounting periods on your tenant. This operation makes an HTTP GET request to the /v1/accounting-periods endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
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
| Defines if the 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 accounting period
`<mule-zuora-connector:get-v1-accounting-periods-by-ap-id>`
Retrieves an accounting period. This operation makes an HTTP GET request to the /v1/accounting-periods/{ap-id} endpoint.
### Before You Begin
You must have Zuora Finance enabled on your tenant.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
ID of the accounting period you want to get.  
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 job of hard deleting billing document files
`<mule-zuora-connector:get-v1-accounts-billing-documents-files-deletion-jobs-by-job-id>`
Retrieves information about an asynchronous job of permanently deleting all billing document PDF files for specific accounts. **Note** : This operation can be used only if you have the Billing user permission "Hard Delete Billing Document Files" enabled. This operation makes an HTTP GET request to the /v1/accounts/billing-documents/files/deletion-jobs/{jobId} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
The unique ID of a billing document file deletion job. For example, 2c92c8f83dc4f752013dc72c24ee016c.  
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


## Get account
`<mule-zuora-connector:get-v1-accounts-by-account-key>`
Retrieves basic information about a customer account. This operation is a quick retrieval that doesn’t include the account’s subscriptions, invoices, payments, or usage details. Use Get account summary to get more detailed information about an account. This operation makes an HTTP GET request to the /v1/accounts/{account-key} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | 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.  
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 account summary
`<mule-zuora-connector:get-v1-accounts-summary-by-account-key>`
Retrieves detailed information about the specified customer account. The response includes the account information and a summary of the account’s subscriptions, invoices, payments, and usages for the last six recently updated subscriptions. ## Notes Returns only the six most recent subscriptions based on the subscription updatedDate. Within those subscriptions, there may be many rate plans and many rate plan charges. These items are subject to the maximum limit on the array size. This operation makes an HTTP GET request to the /v1/accounts/{account-key}/summary endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | 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.  
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 amendments by key
`<mule-zuora-connector:get-v1-amendments-by-amendment-key>`
Retrieves detailed information about the specified subscription amendment. This operation makes an HTTP GET request to the /v1/amendments/{amendment-key} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Amendment key | Can be the amendment ID or the amendment code.  
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 amendments by subscription ID
`<mule-zuora-connector:get-v1-amendments-subscriptions-by-subscription-id>`
Retrieves detailed information about the amendment with the specified subscription. This operation makes an HTTP GET request to the /v1/amendments/subscriptions/{subscription-id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Subscription id | The ID of the subscription whose amendment changes 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


### Throws
  * MULE-ZUORA-CONNECTOR:BAD_REQUEST
  * MULE-ZUORA-CONNECTOR:CLIENT_ERROR
  * MULE-ZUORA-CONNECTOR:CONNECTIVITY
  * MULE-ZUORA-CONNECTOR:INTERNAL_SERVER_ERROR
  * MULE-ZUORA-CONNECTOR:NOT_ACCEPTABLE
  * MULE-ZUORA-CONNECTOR:NOT_FOUND
  * MULE-ZUORA-CONNECTOR:RETRY_EXHAUSTED
  * MULE-ZUORA-CONNECTOR:SERVER_ERROR
  * MULE-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 job status and response
`<mule-zuora-connector:get-v1-async-jobs-by-job-id>`
**Note:** This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature enabled. This operation is in **Limited Availability**. Get the status and response of an asynchronous job. Currently, an asynchronous job created by "Create order asynchronously" or "Preview order asynchronously" is supported. This operation makes an HTTP GET request to the /v1/async-jobs/{jobId} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
UUID of the asynchronous job created by an asynchronous API operation.  
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


## View attachments
`<mule-zuora-connector:get-v1-attachments-by-attachment-id>`
Use the View Attachment REST request to retrieve information about an attachment document. This operation makes an HTTP GET request to the /v1/attachments/{attachment-id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Attachment id | Id of the attachment you want to view.  
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


## View attachments list
`<mule-zuora-connector:get-v1-attachments-by-object-type-object-key>`
Use the View Attachment REST request to get a list of attachments on an account, an invoice, or a subscription. This operation makes an HTTP GET request to the /v1/attachments/{object-type}/{object-key} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Object type |  Enumeration, one of:
  * ACCOUNT
  * INVOICE
  * SUBSCRIPTION
## View attachments list
`<mule-zuora-connector:get-v1-attachments-by-object-type-object-key>`
Use the View Attachment REST request to get a list of attachments on an account, an invoice, or a subscription. This operation makes an HTTP GET request to the /v1/attachments/{object-type}/{object-key} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Object type |  Enumeration, one of:
  * ACCOUNT
  * INVOICE
  * SUBSCRIPTION

| The type of object to list attachements for.  
Object key | ID of the object to list attachements for. - If `object-type` is `account`, specify an account ID. - If `object-type` is `invoice`, specify an invoice ID. - If `object-type` is `subscription`, specify a subscription number.  
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 billing documents
`<mule-zuora-connector:get-v1-billing-documents>`
Retrieves the information about all billing documents associated with a specified account. The billing documents contain invoices, credit memos, and debit memos. To retrieve information about credit memos and debit memos, you must have the Invoice Settlement feature enabled. You can use query parameters to restrict the data returned in the response. Examples: - /billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1&sort=+documentDate - /billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1&status=Posted This operation makes an HTTP GET request to the /v1/billing-documents endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The ID of the customer account that the billing documents are associated with.  
Page Size | Number of rows returned per page.  
Enumeration, one of:
  * DRAFT
  * POSTED
  * CANCELED
  * ERROR

| The status of the billing document.  
Document Date | The date of the billing document. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos.  
This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on. If you do not specify any sortable field, the response data is sorted by the `documentDate` field in descending order. A sortable field uses the following form: **operator** **field_name** You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example: **operator** **field_name** , **operator** **field_name** **operator** is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field. - The `-` operator indicates an ascending order. - The `+` operator indicates a descending order. **field_name** indicates the name of a sortable field. The supported sortable fields of this operation are as below: - documentDate - documentType Examples: - /billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1 &sort=+documentDate,-documentType - /billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1 &status=Posted&sort=+documentDate&page=2&pageSize=15  
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 Billing Preview Run
`<mule-zuora-connector:get-v1-billing-preview-runs-by-billing-preview-run-id>`
**Note:** This feature is in **Limited Availability**. If you want access to this feature, submit a request to Zuora Global Support. Retrieves a preview of future invoice items for multiple customer accounts through a billing preview run. If you have the Invoice Settlement feature enabled, you can also retrieve a preview of future credit memo items. The Invoice Settlement feature is in **Limited Availability**. If you want access to this feature, submit a request to Zuora Global Support. A billing preview run asynchronously generates a downloadable CSV file containing a preview of invoice item data and credit memo item data for a batch of customer accounts. This operation makes an HTTP GET request to the /v1/billing-preview-runs/{billingPreviewRunId} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Billing Preview Run Id | Id of the billing preview run.  
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 mass action result
`<mule-zuora-connector:get-v1-bulk-by-bulk-key>`
This reference describes how to get information about the result of a mass action through the REST API. This operation makes an HTTP GET request to the /v1/bulk/{bulk-key} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | 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


## Get product
`<mule-zuora-connector:get-v1-catalog-product-by-product-id>`
Retrieves detailed information about a specific product, including information about its product rate plans and charges. This operation makes an HTTP GET request to the /v1/catalog/product/{product-id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Product id | The unique ID of the product you want to retrieve. For example, 8a808255575bdae4015774e9602e16fe.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
Zuora version | The minor version of the Zuora REST API. You only need to set this parameter if you use the `productRatePlans` field.  
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 Product Catalog
`<mule-zuora-connector:get-v1-catalog-products>`
Retrieves the entire product catalog, including all products, features, and their corresponding product rate plans, charges. Products are returned in reverse chronological order on the `UpdatedDate` field. With product rate plans and rate plan charges, the REST API has a maximum array size. This operation makes an HTTP GET request to the /v1/catalog/products endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
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.  
Zuora version | The minor version of the Zuora REST API. You only need to set this parameter if you use the `productRatePlans` field.  
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 charge summary details by CRS number
`<mule-zuora-connector:get-v1-charge-revenue-summaries-by-crs-number>`
This REST API reference describes how to retrieve the details of a charge revenue summary by specifying the charge revenue summary number. The response includes all revenue items associated with the charge revenue summary. This operation makes an HTTP GET request to the /v1/charge-revenue-summaries/{crs-number} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Crs number | The charge revenue summary number.  
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 charge summary details by charge ID
`<mule-zuora-connector:get-v1-charge-revenue-summaries-subscription-charges-by-charge-key>`
This REST API reference describes how to retrieve the details of a charge revenue summary by specifying the subscription charge ID. This response retrieves all revenue items associated with a charge revenue summary. This operation makes an HTTP GET request to the /v1/charge-revenue-summaries/subscription-charges/{charge-key} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Charge key | ID of the subscription rate plan charge; for example, 402892793e173340013e173b81000012.  
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 Credit Memos
`<mule-zuora-connector:get-v1-creditmemos>`
Retrieves the information about all credit memos.
The Invoice Settlement feature is in **Limited Availability**. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request to Zuora Global Support.
### Filtering
You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body. If the value of a filterable field is string, you can set the corresponding query parameter to `null` when filtering. Then, you can get the response data with this field value being `null`.
Examples:
  * /v1/creditmemos?status=Processed
  * /v1/creditmemos?referredInvoiceId=null&status=Draft
  * /v1/creditmemos?status=Processed&type=External&sort=+number


This operation makes an HTTP GET request to the /v1/creditmemos endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Auto Apply Upon Posting | This parameter filters the response based on the `autoApplyUponPosting` field.  
Target Date | This parameter filters the response based on the `targetDate` field.  
Unapplied Amount | This parameter filters the response based on the `unappliedAmount` field.  
This parameter filters the response based on the `number` field.  
Created By Id | This parameter filters the response based on the `createdById` field.  
Referred Invoice Id | This parameter filters the response based on the `referredInvoiceId` field.  
Transferred To Accounting |  Enumeration, one of:
  * PROCESSING
  * ERROR
  * IGNORE

| This parameter filters the response based on the `transferredToAccounting` field.  
Applied Amount | This parameter filters the response based on the `appliedAmount` field.  
Account Id | This parameter filters the response based on the `accountId` field.  
This parameter filters the response based on the `amount` field.  
Tax Amount | This parameter filters the response based on the `taxAmount` field.  
Exclude From Auto Apply Rules | This parameter filters the response based on the `excludeFromAutoApplyRules` field.  
Page Size | Number of rows returned per page.  
Enumeration, one of:
  * DRAFT
  * POSTED
  * CANCELED
  * ERROR
  * PENDING_FOR_TAX
  * GENERATING
  * CANCEL_IN_PROGRESS

| This parameter filters the response based on the `status` field.  
currency | This parameter filters the response based on the `currency` field.  
Refund Amount | This parameter filters the response based on the `refundAmount` field.  
Updated By Id | This parameter filters the response based on the `updatedById` field.  
Credit Memo Date | This parameter filters the response based on the `creditMemoDate` field.  
This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on. A sortable field uses the following form: **operator** **field_name** You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example: **operator** **field_name** , **operator** **field_name** **operator** is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field. - The `-` operator indicates an ascending order. - The `+` operator indicates a descending order. By default, the response data is displayed in descending order by credit memo number. **field_name** indicates the name of a sortable field. The supported sortable fields of this operation are as below: - accountId - amount - appliedAmount - createdById - createdDate - creditMemoDate - number - referredInvoiceId - refundAmount - status - targetDate - taxAmount - totalTaxExemptAmount - transferredToAccounting - unappliedAmount - updatedDate Examples: - /v1/creditmemos?sort=+number - /v1/creditmemos?status=Processed&sort=-number,+amount  
Total Tax Exempt Amount | This parameter filters the response based on the `totalTaxExemptAmount` field.  
Updated Date | This parameter filters the response based on the `updatedDate` field.  
Created Date | This parameter filters the response based on the `createdDate` field.  
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 credit memo
`<mule-zuora-connector:get-v1-creditmemos-by-credit-memo-id>`
**Note:** The Invoice Settlement feature is in **Limited Availability**. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request to Zuora Global Support. Retrieves the information about a specific credit memo. This operation makes an HTTP GET request to the /v1/creditmemos/{creditMemoId} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | 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


## Get credit Memo Items
`<mule-zuora-connector:get-v1-creditmemos-items-by-credit-memo-id>`
The Invoice Settlement feature is in **Limited Availability**. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request to Zuora Global Support. Retrieves the information about all items of a credit memo. A credit memo item is a single line item in a credit memo.
### Filtering
You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body. If the value of a filterable field is string, you can set the corresponding query parameter to `null` when filtering. Then, you can get the response data with this field value being `null`.
Examples:
  * /v1/creditmemos/402890245c7ca371015c7cb40ac30015/items?amount=100
  * /v1/creditmemos/402890245c7ca371015c7cb40ac30015/items?amount=100&sort=createdDate
## Get credit Memo Items
`<mule-zuora-connector:get-v1-creditmemos-items-by-credit-memo-id>`
The Invoice Settlement feature is in **Limited Availability**. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request to Zuora Global Support. Retrieves the information about all items of a credit memo. A credit memo item is a single line item in a credit memo.
### Filtering
You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body. If the value of a filterable field is string, you can set the corresponding query parameter to `null` when filtering. Then, you can get the response data with this field value being `null`.
Examples:
  * /v1/creditmemos/402890245c7ca371015c7cb40ac30015/items?amount=100
  * /v1/creditmemos/402890245c7ca371015c7cb40ac30015/items?amount=100&sort=createdDate


This operation makes an HTTP GET request to the /v1/creditmemos/{creditMemoId}/items endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Credit Memo Id | The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.  
Service End Date | This parameter filters the response based on the `serviceEndDate` field.  
Created By Id | This parameter filters the response based on the `createdById` field.  
This parameter filters the response based on the `sku` field.  
Sku Name | This parameter filters the response based on the `skuName` field.  
Source Item Id | This parameter filters the response based on the `sourceItemId` field.  
Service Start Date | This parameter filters the response based on the `serviceStartDate` field.  
Subscription Id | This parameter filters the response based on the `subscriptionId` field.  
Applied Amount | This parameter filters the response based on the `appliedAmount` field.  
This parameter filters the response based on the `amount` field.  
This parameter filters the response based on the `id` field.  
Page Size | Number of rows returned per page.  
Refund Amount | This parameter filters the response based on the `refundAmount` field.  
Updated By Id | This parameter filters the response based on the `updatedById` field.  
This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on. A sortable field uses the following form: **operator** **field_name** You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example: **operator** **field_name** , **operator** **field_name** **operator** is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field. - The `-` operator indicates an ascending order. - The `+` operator indicates a descending order. By default, the response data is displayed in descending order by updated date. **field_name** indicates the name of a sortable field. The supported sortable fields of this operation are as below: - amount - appliedAmount - createdById - createdDate - id - refundAmount - serviceEndDate - serviceStartDate - sku - skuName - sourceItemId - subscriptionId - updatedById - updatedDate Examples: - /v1/creditmemos/402890245c7ca371015c7cb40ac30015/items?sort=createdDate - /v1/creditmemos/402890245c7ca371015c7cb40ac30015/items?amount=100&sort=createdDate  
Updated Date | This parameter filters the response based on the `updatedDate` field.  
Created Date | This parameter filters the response based on the `createdDate` field.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
Zuora version | The minor version of the Zuora REST API. See [Minor Version](https://www.zuora.com/developer/api-reference/#section/API-Versions/Minor-Version) for information about REST API version control. This header affects the availability of the following response fields: * `items` > `creditTaxItems` * `items` > `taxationItems` * `items` > `comment` * `items` > `description`  
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
| Defines if the 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 credit memo item
`<mule-zuora-connector:get-v1-creditmemos-items-by-credit-memo-id-cmitemid>`
The Invoice Settlement feature is in **Limited Availability**. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request to Zuora Global Support.
Retrieves the information about a specific item of a credit memo. A credit memo item is a single line item in a credit memo. This operation makes an HTTP GET request to the /v1/creditmemos/{creditMemoId}/items/{cmitemid} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
cmitemid | 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).  
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.  
Zuora version | The minor version of the Zuora REST API. See [Minor Version](https://www.zuora.com/developer/api-reference/#section/API-Versions/Minor-Version) for information about REST API version control. This header affects the availability of the following response fields: * `creditTaxItems` * `taxationItems` * `comment` * `description`  
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 items of credit memo item
`<mule-zuora-connector:get-v1-creditmemos-items-taxation-items-by-credit-memo-id-cmitemid>`
**Note:** The Invoice Settlement feature is in **Limited Availability**. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request to Zuora Global Support. Retrieves information about the taxation items of a specific credit memo item. This operation makes an HTTP GET request to the /v1/creditmemos/{creditMemoId}/items/{cmitemid}/taxation-items endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
cmitemid | 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).  
Credit Memo Id | The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.  
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