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

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

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

| A retry strategy in case of connectivity errors  
### Output
Array of String  
---  
### 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 parts
`<mule-zuora-connector:get-v1-creditmemos-parts-by-credit-memo-id>`
**Note:** The Invoice Settlement feature is in **Limited Availability**. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request to Zuora Global Support. Retrieves the information about all parts of a credit memo. A credit memo can consist of an unapplied part, and several parts applied to invoices and debit memos. You can use this operation to get all the applied and unapplied portions of a credit memo. This operation makes an HTTP GET request to the /v1/creditmemos/{creditMemoId}/parts endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
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

| Defines if the 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 part
`<mule-zuora-connector:get-v1-creditmemos-parts-by-credit-memo-id-partid>`
**Note:** The Invoice Settlement feature is in **Limited Availability**. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request to Zuora Global Support. Retrieves the information about a specific credit memo part. A credit memo can consist of an unapplied part, and several parts applied to invoices and debit memos. This operation makes an HTTP GET request to the /v1/creditmemos/{creditMemoId}/parts/{partid} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
The unique ID of a specific credit memo part. You can get the credit memo part ID from the response of [Get credit memo parts](https://www.zuora.com/developer/api-reference/#operation/GET_CreditMemoParts).  
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
| 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 part items
`<mule-zuora-connector:get-v1-creditmemos-parts-itemparts-by-credit-memo-id-partid>`
**Note:** The Invoice Settlement feature is in **Limited Availability**. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request to Zuora Global Support. Retrieves the information about all items of a credit memo part. A credit memo part item is a single line item in a credit memo part. A credit memo part can consist of several different types of items. This operation makes an HTTP GET request to the /v1/creditmemos/{creditMemoId}/parts/{partid}/itemparts endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
The unique ID of a specific credit memo part. You can get the credit memo part ID from the response of [Get credit memo parts](https://www.zuora.com/developer/api-reference/#operation/GET_CreditMemoParts). .  
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

| Defines if the 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 part item
`<mule-zuora-connector:get-v1-creditmemos-parts-itemparts-by-credit-memo-id-partid-itempartid>`
**Note:** The Invoice Settlement feature is in **Limited Availability**. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request to Zuora Global Support. Retrieves the information about a specific credit memo part item. A credit memo part item is a single line item in a credit memo part. A credit memo part can consist of several different types of items. This operation makes an HTTP GET request to the /v1/creditmemos/{creditMemoId}/parts/{partid}/itemparts/{itempartid} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
The unique ID of a specific credit memo part. You can get the credit memo part ID from the response of [Get credit memo parts](https://www.zuora.com/developer/api-reference/#operation/GET_CreditMemoParts).  
itempartid | The unique ID of a specific credit memo part item. You can get the credit memo part item ID from the response of [Get credit memo part items](https://www.zuora.com/developer/api-reference/#operation/GET_CreditMemoItemParts).  
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 custom foreign currency exchange rates
`<mule-zuora-connector:get-v1-custom-exchange-rates-by-currency>`
This feature is in **Limited Availability**. If you want access to this feature, submit a request to Zuora Global Support. This reference describes how to query custom foreign exchange rates from Zuora. You can use this API method to query exchange rates only if you use a custom exchange rate provider and upload rates with the Import Foreign Exchange Rates mass action. This operation makes an HTTP GET request to the /v1/custom-exchange-rates/{currency} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
currency | The target base currency of the tenant. The exchange rates in the response are calculated in relation to the target currency. The value must be a three-letter currency code, for example, USD.  
Start Date | Start date of the date range for which you want to get exchange rates. The date must be in yyyy-mm-dd format, for example, 2016-01-15. The start date cannot be later than the end date.  
End Date | End date of the date range for which you want to get exchange rates. The date must be in yyyy-mm-dd format, for example, 2016-01-16. The end date can be a maximum of 90 days after the start date.  
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 Debit Memos
`<mule-zuora-connector:get-v1-debitmemos>`
Retrieves the information about all debit memos associated with all customer accounts.
**Note:** The Invoice Settlement feature is in **Limited Availability**. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request 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/debitmemos?status=Processed
  * /v1/debitmemos?referredInvoiceId=null&status=Draft
  * /v1/debitmemos?status=Processed&type=External&sort=+number


This operation makes an HTTP GET request to the /v1/debitmemos endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Target Date | This parameter filters the response based on the `targetDate` field.  
This parameter filters the response based on the `number` field.  
Be Applied Amount | This parameter filters the response based on the `beAppliedAmount` 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.  
Debit Memo Date | This parameter filters the response based on the `debitMemoDate` field.  
This parameter filters the response based on the `balance` 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.  
Page Size | Number of rows returned per page.  
Enumeration, one of:
  * DRAFT
  * POSTED
  * CANCELED
  * ERROR
  * PENDING_FOR_TAX
  * GENERATING
  * CANCEL_IN_PROGRESS
This operation makes an HTTP GET request to the /v1/debitmemos endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Target Date | This parameter filters the response based on the `targetDate` field.  
This parameter filters the response based on the `number` field.  
Be Applied Amount | This parameter filters the response based on the `beAppliedAmount` 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.  
Debit Memo Date | This parameter filters the response based on the `debitMemoDate` field.  
This parameter filters the response based on the `balance` 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.  
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.  
Due Date | This parameter filters the response based on the `dueDate` field.  
currency | This parameter filters the response based on the `currency` 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 debit memo number. **field_name** indicates the name of a sortable field. The supported sortable fields of this operation are as below: - number - accountId - debitMemoDate - targetDate - dueDate - amount - taxAmount - totalTaxExemptAmount - balance - beAppliedAmount - referredInvoiceId - createdDate - createdById - updatedDate - updatedById Examples: - /v1/debitmemos?sort=+number - /v1/debitmemos?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


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


## Get debit memo application parts
`<mule-zuora-connector:get-v1-debitmemos-application-parts-by-debit-memo-id>`
This feature is in **Limited Availability**. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request to Zuora Global Support.
Retrieves information about the payments or credit memos that are applied to a specified debit memo.
This operation makes an HTTP GET request to the /v1/debitmemos/{debitMemoId}/application-parts endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Debit Memo Id | The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
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 Debit Memo
`<mule-zuora-connector:get-v1-debitmemos-by-debit-memo-id>`
This feature is in **Limited Availability**. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request to Zuora Global Support.
Retrieves the information about a specific debit memo.
This operation makes an HTTP GET request to the /v1/debitmemos/{debitMemoId} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Debit Memo Id | The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
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 Debit Memo Items
`<mule-zuora-connector:get-v1-debitmemos-items-by-debit-memo-id>`
**Note:** The Invoice Settlement feature is in **Limited Availability**. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request to Zuora Global Support.
Retrieves the information about all items of a debit memo. A debit memo item is a single line item in a debit memo.
### Filtering
You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body. If the value of a filterable field is string, you can set the corresponding query parameter to `null` when filtering. Then, you can get the response data with this field value being `null`.
Examples:
  * /v1/debitmemos/402890245c7ca371015c7cb40b28001f/items?amount=100
  * /v1/debitmemos/402890245c7ca371015c7cb40b28001f/items?amount=100&sort=createdDate
## Get Debit Memo Items
`<mule-zuora-connector:get-v1-debitmemos-items-by-debit-memo-id>`
**Note:** The Invoice Settlement feature is in **Limited Availability**. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request to Zuora Global Support.
Retrieves the information about all items of a debit memo. A debit memo item is a single line item in a debit memo.
### Filtering
You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body. If the value of a filterable field is string, you can set the corresponding query parameter to `null` when filtering. Then, you can get the response data with this field value being `null`.
Examples:
  * /v1/debitmemos/402890245c7ca371015c7cb40b28001f/items?amount=100
  * /v1/debitmemos/402890245c7ca371015c7cb40b28001f/items?amount=100&sort=createdDate


This operation makes an HTTP GET request to the /v1/debitmemos/{debitMemoId}/items endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Debit Memo Id | The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e.  
Service End Date | This parameter filters the response based on the `serviceEndDate` field.  
Be Applied Amount | This parameter filters the response based on the `beAppliedAmount` 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.  
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.  
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: - id - amount - beAppliedAmount - sku - skuName - serviceStartDate - serviceEndDate - sourceItemId - createdDate - createdById - updatedDate - updatedById - subscriptionId Examples: - /v1/debitmemos/402890245c7ca371015c7cb40b28001f/items?sort=createdDate - /v1/debitmemos/402890245c7ca371015c7cb40b28001f/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` > `taxItems` * `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 Debit Memo Item
`<mule-zuora-connector:get-v1-debitmemos-items-by-debit-memo-id-dmitemid>`
**Note:** The Invoice Settlement feature is in **Limited Availability**. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request to Zuora Global Support.
Retrieves information about a specific item of a debit memo. A debit memo item is a single line item in a debit memo.
This operation makes an HTTP GET request to the /v1/debitmemos/{debitMemoId}/items/{dmitemid} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
dmitemid | The unique ID of a debit memo item. You can get the debit memo item ID from the response of [Get debit memo items](https://www.zuora.com/developer/api-reference/#operation/GET_DebitMemoItems).  
Debit Memo Id | The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
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: * `taxItems` * `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 debit memo item
`<mule-zuora-connector:get-v1-debitmemos-items-taxation-items-by-debit-memo-id-dmitemid>`
**Note:** The Invoice Settlement feature is in **Limited Availability**. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request to Zuora Global Support. Retrieves information about the taxation items of a specific debit memo item. This operation makes an HTTP GET request to the /v1/debitmemos/{debitMemoId}/items/{dmitemid}/taxation-items endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
dmitemid | The unique ID of a debit memo item. You can get the debit memo item ID from the response of [Get debit memo items](https://www.zuora.com/developer/api-reference/#operation/GET_DebitMemoItems).  
Debit Memo Id | The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e.  
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
| 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 String  
---  
### 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


## Describe object
`<mule-zuora-connector:get-v1-describe-by-object>`
Provides a reference listing for each object that is available in your Zuora tenant. The information returned by this call is useful if you are using CRUD: Create Export or the AQuA API to create a data source export. See Export ZOQL for more information.
### Response
The response contains an XML document that lists the fields of the specified object. Each of the object’s fields is represented by an element in the XML document. Each field element contains the following elements:
Description  
---  
API name of the field.  
Name of the field in the Zuora user interface.  
Data type of the field. The possible data types are: `boolean`, `date`, `datetime`, `decimal`, `integer`, `picklist`, `text`, `timestamp`, and `ZOQL`. If the data type is `picklist`, the `<field>` element contains an `<options>` element that lists the possible values of the field.  
`<contexts>` | Specifies the availability of the field. If the `<contexts>` element lists the `export` context, the field is available for use in data source exports.  
The `<field>` element contains other elements that provide legacy information about the field. This information is not directly related to the REST API.
Response sample:
```
<?xml version="1.0" encoding="UTF-8"?>
<object>
 <name>ProductRatePlanCharge</name>
 <label>Product Rate Plan Charge</label>
 <fields>
  ...
  <field>
   <name>TaxMode</name>
   <label>Tax Mode</label>
   <type>picklist</type>
   <options>
    <option>TaxExclusive</option>
    <option>TaxInclusive</option>
   </options>
   <contexts>
    <context>export</context>
   </contexts>
   ...
  </field>
  ...
 </fields>
</object>
```

It is strongly recommended that your integration checks `<contexts>` elements in the response. If your integration does not check `<contexts>` elements, your integration may process fields that are not available for use in data source exports. See Changes to the Describe API for more information.
This operation makes an HTTP GET request to the /v1/describe/{object} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
API name of an object in your Zuora tenant. For example, `InvoiceItem`. See [Zuora Object Model](https://www.zuora.com/developer/api-reference/#section/Zuora-Object-Model) for the list of valid object names. Depending on the features enabled in your Zuora tenant, you may not be able to list the fields of some objects.  
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 document properties
`<mule-zuora-connector:get-v1-document-properties-by-document-type-document-id>`
This feature is available only if you have the Billing Document Properties Setup feature enabled. The Billing Document Properties Setup feature is in **Limited Availability**. If you want access to this feature, submit a request to Zuora Global Support.
You can retrieve information about document properties of a billing document. Billing documents include invoices, credit memos, and debit memos. **Note:** You can retrieve information about document properties of credit and debit memos only if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in **Limited Availability**. If you want access to this feature, submit a request to Zuora Global Support.
This operation makes an HTTP GET request to the /v1/document-properties/{documentType}/{documentId} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Document Type |  Enumeration, one of:
  * INVOICE
  * CREDIT_MEMO
  * DEBIT_MEMO
## Get document properties
`<mule-zuora-connector:get-v1-document-properties-by-document-type-document-id>`
This feature is available only if you have the Billing Document Properties Setup feature enabled. The Billing Document Properties Setup feature is in **Limited Availability**. If you want access to this feature, submit a request to Zuora Global Support.
You can retrieve information about document properties of a billing document. Billing documents include invoices, credit memos, and debit memos. **Note:** You can retrieve information about document properties of credit and debit memos only if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in **Limited Availability**. If you want access to this feature, submit a request to Zuora Global Support.
This operation makes an HTTP GET request to the /v1/document-properties/{documentType}/{documentId} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Document Type |  Enumeration, one of:
  * INVOICE
  * CREDIT_MEMO
  * DEBIT_MEMO

| The type of the billing document.  
Document Id | The unique ID of document properties to be retrieved. For example, 402892c74c9193cd014c96bbe7c101f9.  
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


## Multi-entity: Get entities
`<mule-zuora-connector:get-v1-entities>`
The Multi-entity feature is in **Limited Availability**. If you want access to this feature, submit a request to Zuora Global Support.
Retrieves detailed information of certain entities in a multi-entity hierarchy.
You can retrieve:
  * Provisioned entities
  * Unprovisioned entities
  * Both provisioned and unprovisioned entities


### User Access Permission
You can make the call as any entity user.
This operation makes an HTTP GET request to the /v1/entities endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
provisioned | Specify whether to retrieve provisioned or unprovisioned entities: - `true`: Provisioned entities - `false`: Unprovisioned entities If you do not specify this field in the request, both the provisioned and unprovisioned entities are returned.  
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


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


## Multi-entity: Get connections
`<mule-zuora-connector:get-v1-entity-connections>`
The Multi-entity feature is in **Limited Availability**. If you want access to this feature, submit a request to Zuora Global Support.
Retrieves information about certain connections for a specified entity. You can specify the entity to retrieve in the `Zuora-Entity-Ids` request header.
You can retrieve:
  * Inbound connections
  * Outbound connections
  * Both inbound and outbound connections


### User Access Permission
You can make the call as any entity user.
This operation makes an HTTP GET request to the /v1/entity-connections endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Page Size | Number of rows returned per page.  
Enumeration, one of:
  * INBOUND
  * OUTBOUND

| Specifies whether to retrieve inbound or outbound connections for an entity. Possible values: - `inbound`: All the incoming connections to the entity. - `outbound`: All the outgoing connections from the entity. If you do not specify this field in the request, both the inbound and outbound connections are returned.  
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 files
`<mule-zuora-connector:get-v1-files-by-file-id>`
Retrieve files such as export results, invoices, and accounting period reports.
The maximum file size is 2047MB. If you have a data request that exceeds this limit, Zuora returns the following 403 response: `2047MB`. Submit a request to Zuora Global Support to determine if large file optimization is an option for you.   
---  
This operation makes an HTTP GET request to the /v1/files/{file-id} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
The Zuora ID of the file 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


## Return Hosted Pages
`<mule-zuora-connector:get-v1-hostedpages>`
Returns the Payment Pages configuration metadata, specifically, page ID, page version, payment method type.
The following are the version-specific and general REST requests for Payment Pages:
  * The request for Payment Pages 1.0 configuration information: `GET /hostedpages?version=1`
  * The request for Payment Pages 2.0 configuration information: `GET /hostedpages?version=2`
  * The request for all versions of Payment Pages configuration information: `GET /hostedpages`


### Notes
If you do not have the corresponding tenant setting enabled, for example, the request `version` parameter set to 2 with the Payment Pages 2.0 setting disabled, you will receive an error.
This operation makes an HTTP GET request to the /v1/hostedpages endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Version Number | Version of the Payment Pages for which you want to retrieve the configuration information. Specify 1 for Payment Pages 1.0 or 2 for Payment Pages 2.0. If omitted, information for all versions of Payment Pages are returned. The response also depends on your tenant settings for Payment Pages 1.0 and Payment Pages 2.0. For example, if only the tenant setting for Payment Pages 2.0 is enabled, the response will only contain information for Payment Pages 2.0 forms even when this parameter is omitted.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of 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 invoice application parts
`<mule-zuora-connector:get-v1-invoices-application-parts-by-invoice-id>`
Note: The Invoice Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you wish to have access to the feature, submit a request at Zuora Global Support. Retrieves information about the payments or credit memos that are applied to a specified invoice. This operation makes an HTTP GET request to the /v1/invoices/{invoiceId}/application-parts endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Invoice Id | The unique ID of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab.  
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 invoice files
`<mule-zuora-connector:get-v1-invoices-files-by-invoice-id>`
Retrieves the information about all PDF files of a specified invoice. Invoice PDF files are returned in reverse chronological order by the value of the `versionNumber` field. This operation makes an HTTP GET request to the /v1/invoices/{invoiceId}/files endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Invoice Id | The unique ID of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab.  
Page Size | Number of rows returned per page.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
Initial Page Number | The initial page to get in the first request  
Output Mime Type | The mime type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

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

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

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

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

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

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

| A retry strategy in case of connectivity errors  
### Output
Array of Any  
---  
### For Configurations
  * Configurations


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


## Get invoice items
`<mule-zuora-connector:get-v1-invoices-items-by-invoice-id>`
Retrieves the information about all items of a specified invoice. This operation makes an HTTP GET request to the /v1/invoices/{invoiceId}/items endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Invoice Id | The unique ID of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab.  
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 taxation items of invoice item
`<mule-zuora-connector:get-v1-invoices-items-taxation-items-by-invoice-id-item-id>`
Retrieves information about the taxation items of a specific invoice item. This operation makes an HTTP GET request to the /v1/invoices/{invoiceId}/items/{itemId}/taxation-items endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Invoice Id | The unique ID of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab.  
The unique ID of an invoice item. For example, 2c86c8955bd63cc1015bd7c151af02ef.  
Page Size | Number of rows returned per page.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
Initial Page Number | The initial page to get in the first request  
Output Mime Type | The mime type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

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

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

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

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

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

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

| A retry strategy in case of connectivity errors  
### Output
Array of Any  
---  
### For Configurations
  * Configurations


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


## Get summary journal entry
`<mule-zuora-connector:get-v1-journal-entries-by-je-number>`
This REST API reference describes how to get information about a summary journal entry by its journal entry number. This operation makes an HTTP GET request to the /v1/journal-entries/{je-number} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Je number | Je 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 all summary journal entries in a journal run
`<mule-zuora-connector:get-v1-journal-entries-journal-runs-by-jr-number>`
This REST API reference describes how to retrieve information about all summary journal entries in a journal run. This operation makes an HTTP GET request to the /v1/journal-entries/journal-runs/{jr-number} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Jr number | Journal run 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
| Defines if the 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 journal run
`<mule-zuora-connector:get-v1-journal-runs-by-jr-number>`
This REST API reference describes how to get information about a journal run. Request and response field descriptions and sample code are provided. This operation makes an HTTP GET request to the /v1/journal-runs/{jr-number} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Jr number | Journal run number. Must be a valid journal run number in the format `JR-00000001`.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

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

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

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


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


## Get callout notification histories
`<mule-zuora-connector:get-v1-notification-history-callout>`
This REST API reference describes how to get a notification history for callouts. This operation makes an HTTP GET request to the /v1/notification-history/callout endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Start Time | The initial date and time of records to be returned. Defaults to (end time - 1 day). Use format yyyy-MM-ddTHH:mm:ss.  
Event Category | Category of records to be returned by event category. The following formats are supported: * `{Event Type Namespace}:{Event Type Name}` if the Configurable Event features are enabled in your Zuora tenant. For example: `user.notification:NewSubscriptionCreated`. * Otherwise, numeric code of the event category. For example, `1210`. See [Event Categories for Notifications](https://knowledgecenter.zuora.com/DC_Developers/AA_REST_API/Event_Categories_for_Notification_Histories) for more information.  
Failed Only | If `true`, only return failed records. If `false`, return all records in the given date range. The default value is `true`.  
End Time | The final date and time of records to be returned. Defaults to now. Use format yyyy-MM-ddTHH:mm:ss.  
Page Size | Number of rows returned per page.  
Object Id | The ID of an object that triggered a callout notification.  
Include Response Content | Include Response Content  
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 email notification histories
`<mule-zuora-connector:get-v1-notification-history-email>`
This REST API reference describes how to get a notification history for notification emails. ## Notes Request parameters and their values may be appended with a "?" following the HTTPS GET request. Additional request parameter are separated by "&". For example: `GET https://rest.zuora.com/v1/notification-history/email?startTime=2015-01-12T00:00:00&endTime=2015-01-15T00:00:00&failedOnly=false&eventCategory=1000&pageSize=1` This operation makes an HTTP GET request to the /v1/notification-history/email endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Start Time | The initial date and time of records to be returned. Defaults to (end time - 1 day). Use format yyyy-MM-ddTHH:mm:ss. The maximum date range (endTime - startTime) is three days.  
Event Category | Category of records to be returned by event category. The following formats are supported: * `{Event Type Namespace}:{Event Type Name}` if the Configurable Event features are enabled in your Zuora tenant. For example: `user.notification:NewSubscriptionCreated`. * Otherwise, numeric code of the event category. For example, `1210`. See [Event Categories for Notifications](https://knowledgecenter.zuora.com/DC_Developers/AA_REST_API/Event_Categories_for_Notification_Histories) for more information.  
Failed Only | If `true`, only returns failed records. When `false`, returns all records in the given date range. Defaults to `true` when not specified.  
End Time | The end date and time of records to be returned. Defaults to now. Use format yyyy-MM-ddTHH:mm:ss. The maximum date range (endTime - startTime) is three days.  
Page Size | Number of rows returned per page.  
Object Id | The Id of an object that triggered an email notification.  
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


## CRUD: Get account
`<mule-zuora-connector:get-v1-object-account-by-id>`
Retrieves the information about one specific account. This operation makes an HTTP GET request to the /v1/object/account/{id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Object id  
Object fields to return  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

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

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

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

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


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


## CRUD: Get amendment
`<mule-zuora-connector:get-v1-object-amendment-by-id>`
CRUD: Get amendment This operation makes an HTTP GET request to the /v1/object/amendment/{id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Object id  
Object fields to return  
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: Get bill run
`<mule-zuora-connector:get-v1-object-bill-run-by-id>`
**Note:** This feature is in **Limited Availability**. If you wish to have access to the feature, submit a request to Zuora Global Support. Business operations depending on the completion of the bill run will not be available while the bill run query returns `PostInProgress`. Upon completion of the bill run, a query will return `Posted`. This operation makes an HTTP GET request to the /v1/object/bill-run/{id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Object id  
Object fields to return  
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: Retrieve CommunicationProfile
`<mule-zuora-connector:get-v1-object-communication-profile-by-id>`
CRUD: Retrieve CommunicationProfile This operation makes an HTTP GET request to the /v1/object/communication-profile/{id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Object id  
Object fields to return  
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: Get contact
`<mule-zuora-connector:get-v1-object-contact-by-id>`
Retrieves detailed information about a specific contact. This operation makes an HTTP GET request to the /v1/object/contact/{id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Object id  
Object fields to return  
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: Retrieve CreditBalanceAdjustment
`<mule-zuora-connector:get-v1-object-credit-balance-adjustment-by-id>`
CRUD: Retrieve CreditBalanceAdjustment This operation makes an HTTP GET request to the /v1/object/credit-balance-adjustment/{id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Object id  
Object fields to return  
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: Retrieve Export
`<mule-zuora-connector:get-v1-object-export-by-id>`
Use this operation to check the status of a data source export and access the exported data. When you export data from Zuora, each exported file is available for download for 7 days. Data source exports (Export objects) older than 90 days are automatically deleted. This operation makes an HTTP GET request to the /v1/object/export/{id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Object id  
Object fields to return  
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: Retrieve Feature
`<mule-zuora-connector:get-v1-object-feature-by-id>`
CRUD: Retrieve Feature This operation makes an HTTP GET request to the /v1/object/feature/{id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Object id  
Object fields to return  
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: Retrieve Import
`<mule-zuora-connector:get-v1-object-import-by-id>`
CRUD: Retrieve Import This operation makes an HTTP GET request to the /v1/object/import/{id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Object id  
Object fields to return  
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: Retrieve InvoiceAdjustment
`<mule-zuora-connector:get-v1-object-invoice-adjustment-by-id>`
CRUD: Retrieve InvoiceAdjustment This operation makes an HTTP GET request to the /v1/object/invoice-adjustment/{id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Object id  
Object fields to return  
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: Get invoice
`<mule-zuora-connector:get-v1-object-invoice-by-id>`
CRUD: Get invoice This operation makes an HTTP GET request to the /v1/object/invoice/{id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Object id  
Object fields to return  
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: Retrieve InvoiceItemAdjustment
`<mule-zuora-connector:get-v1-object-invoice-item-adjustment-by-id>`
CRUD: Retrieve InvoiceItemAdjustment This operation makes an HTTP GET request to the /v1/object/invoice-item-adjustment/{id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Object id  
Object fields to return  
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: Retrieve InvoiceItem
`<mule-zuora-connector:get-v1-object-invoice-item-by-id>`
CRUD: Retrieve InvoiceItem This operation makes an HTTP GET request to the /v1/object/invoice-item/{id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Object id  
Object fields to return  
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: Retrieve InvoicePayment
`<mule-zuora-connector:get-v1-object-invoice-payment-by-id>`
CRUD: Retrieve InvoicePayment This operation makes an HTTP GET request to the /v1/object/invoice-payment/{id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Object id  
Object fields to return  
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: Retrieve InvoiceSplit
`<mule-zuora-connector:get-v1-object-invoice-split-by-id>`
CRUD: Retrieve InvoiceSplit This operation makes an HTTP GET request to the /v1/object/invoice-split/{id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Object id  
Object fields to return  
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: Retrieve InvoiceSplitItem
`<mule-zuora-connector:get-v1-object-invoice-split-item-by-id>`
CRUD: Retrieve InvoiceSplitItem This operation makes an HTTP GET request to the /v1/object/invoice-split-item/{id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Object id  
Object fields to return  
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: Get payment
`<mule-zuora-connector:get-v1-object-payment-by-id>`
Retrieves the information about one specific payment. This operation makes an HTTP GET request to the /v1/object/payment/{id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
The unique ID of a payment. For example, 2c92c095592623ea01596621ada84352.  
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: Get payment method
`<mule-zuora-connector:get-v1-object-payment-method-by-id>`
CRUD: Get payment method This operation makes an HTTP GET request to the /v1/object/payment-method/{id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Object id  
Object fields to return  
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: Get payment method snapshot
`<mule-zuora-connector:get-v1-object-payment-method-snapshot-by-id>`
This REST API reference describes how to retrieve a Payment Method Snapshot. A Payment Method Snapshot is a copy of the particular Payment Method used in a transaction. If the Payment Method is deleted, the Payment Method Snapshot continues to retain the data used in each of the past transactions. ## Notes The following Payment Method fields are not available in Payment Method Snapshots: * `Active` * `AchAddress1` * `AchAddress2` * `CreatedById` * `CreatedDate` * `UpdatedById` * `UpdatedDate` The Payment Method Snapshot field `PaymentMethodId` is not available in Payment Methods. This operation makes an HTTP GET request to the /v1/object/payment-method-snapshot/{id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Object id  
Object fields to return  
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: Retrieve PaymentMethodTransactionLog
`<mule-zuora-connector:get-v1-object-payment-method-transaction-log-by-id>`
CRUD: Retrieve PaymentMethodTransactionLog This operation makes an HTTP GET request to the /v1/object/payment-method-transaction-log/{id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Object id  
Object fields to return  
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: Get payment transaction log
`<mule-zuora-connector:get-v1-object-payment-transaction-log-by-id>`
Retrieves information about a specific payment transaction log. This operation makes an HTTP GET request to the /v1/object/payment-transaction-log/{id} endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
The ID of a payment transaction log.  
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