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

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

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

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


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


## Upload File for Debit Memo
`<mule-zuora-connector:create-v1-debitmemos-files-by-debit-memo-id>`
The Invoice Settlement feature is in **Limited Availability**. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to the feature, submit a request to Zuora Global Support.
This operation uploads an externally generated PDF file for a debit memo that is in Draft or Posted status. This operation has the following restrictions:
  * Only the PDF file format is supported.
  * The maximum size of the PDF file to upload is 4 MB.
  * A maximum of 50 PDF files can be uploaded for one debit memo.


This operation makes an HTTP POST request to the `/v1/debitmemos/{debitMemoId}/files` endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Debit Memo Id | The ID of the debit memo that you want to upload a PDF file for. For example, 402890555a87d7f5015a8919e4fe002e.  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
File Content | The content of the 'File' part. | #[payload]  
File Filename | The filename of the 'File' part (just the name, do not include path).  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

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

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

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


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


## Create Debit Memo PDF
`<mule-zuora-connector:create-v1-debitmemos-pdfs-by-debit-memo-id>`
The Invoice Settlement feature is in **Limited Availability**. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to the feature, submit a request to Zuora Global Support.   
---  
This operation creates a PDF file for a specified debit memo. To access the generated PDF file, you can download it by clicking **View PDF** on the detailed debit memo page using the Zuora UI.
This REST API operation can be used only if you have the Billing user permission "Regenerate PDF" enabled.
This operation makes an HTTP POST request to the /v1/debitmemos/{debitMemoId}/pdfs endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Debit Memo Id | The unique ID of the debit memo that you want to create a PDF file for. 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
| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

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

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

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


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


## Create Taxation Items for Debit Memo
`<mule-zuora-connector:create-v1-debitmemos-taxationitems-by-debit-memo-id>`
**Note:** This feature is only available if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in **Limited Availability**. If you want access to this feature, submit a request to Zuora Global Support.
This operation creates taxation items for a debit memo and makes an HTTP POST request to the /v1/debitmemos/{debitMemoId}/taxationitems 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.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

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

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

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


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


## Create Document Properties
`<mule-zuora-connector:create-v1-document-properties>`
This feature is available only if you have the Billing Document Properties Setup feature enabled. The Billing Document Properties Setup feature is in **Limited Availability**. If you want access to the feature, submit a request to Zuora Global Support.   
---  
This operation creates custom document properties for a billing document. For example, a document property. You can be a custom name used for files generated for billing documents. Billing documents include invoices, credit memos, and debit memos. If you want to configure custom file names for billing documents created through API operations, you have to call this operation before posting the billing documents.
You can create document properties for credit and debit memos only if you have the Invoice Settlement feature enabled. The Invoice Settlement feature is in **Limited Availability**. If you want access to this feature, submit a request to Zuora Global Support.
This operation makes an HTTP POST request to the /v1/document-properties endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

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

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

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * Configurations
| 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: Create entity
`<mule-zuora-connector:create-v1-entities>`
The Multi-entity feature is in **Limited Availability**. If you want access to this feature, submit a request to Zuora Global Support.   
---  
You must make the call as a global entity administrator.
### Notes
It is best if you assign only one administrator to manage the entity hierarchy, because an administrator of the global entity can, by default, access only the entities that they create themselves.
This operation makes an HTTP POST request to the `/v1/entities` endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

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

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

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


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


## Multi-entity: Initiate Connection
`<mule-zuora-connector:create-v1-entity-connections>`
The Multi-entity feature is in **Limited Availability**. If you want access to the feature, submit a request to Zuora Global Support.
This operation initiates a connection request from a source entity to a target entity.
### User Access Permission
You must make the call as a source entity administrator. Also, this administrator must have permission to access to the target entity.
This operation makes an HTTP POST request to the `/v1/entity-connections` endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

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

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

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * Configurations
| 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


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

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

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

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

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


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


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

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

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

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

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

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

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

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


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


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

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

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

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

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


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


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

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

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

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

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


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


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


## Create Credit Memo from Invoice
`<mule-zuora-connector:create-v1-invoices-creditmemos-by-invoice-id>`
This operaton creates an ad-hoc credit memo from an invoice.
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.   
---  
You can create a credit memo from an invoice only if you have the user permission. See Billing Roles for more information.
This operation makes an HTTP POST request to the /v1/invoices/{invoiceId}/creditmemos endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Invoice Id | The ID of an invoice that you want to create a credit memo from.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
Zuora version | The minor version of the Zuora REST API. See [Minor Version](https://www.zuora.com/developer/api-reference/#section/API-Versions/Minor-Version) for information about REST API version control. This header affects the availability of the following request fields: * `items` > `comment` * `items` > `description`  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

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

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

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


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


## Create debit memo from invoice
`<mule-zuora-connector:create-v1-invoices-debitmemos-by-invoice-id>`
**Note:** The Invoice Settlement feature is in **Limited Availability**. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to this feature, submit a request to Zuora Global Support. Creates an ad-hoc debit memo from an invoice. You can create a debit memo from an invoice only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. This operation makes an HTTP POST request to the /v1/invoices/{invoiceId}/debitmemos endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Invoice Id | The ID of an invoice that you want to create a debit memo from.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
Zuora version | The minor version of the Zuora REST API. See [Minor Version](https://www.zuora.com/developer/api-reference/#section/API-Versions/Minor-Version) for information about REST API version control. This header affects the availability of the following request fields: * `items` > `comment` * `items` > `description`  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

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

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

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

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

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

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


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


## Email Invoice
`<mule-zuora-connector:create-v1-invoices-emails-by-invoice-id>`
Sends a posted invoice to the specified email addresses manually.
### Notes
  * You must activate the **Manual Email For Invoice | Manual Email For Invoice** notification before emailing invoices. To include the invoice PDF in the email, select the **Include Invoice PDF** check box in the **Edit notification** dialog from the Zuora UI. See [Create and Edit Notifications](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/C_Create_Notifications#section_2) for more information.
  * Zuora sends the email messages based on the email template you set. You can set the email template to use in the **Delivery Options** panel of the **Edit notification** dialog from the Zuora UI. By default, the **Invoice Posted Default Email Template** template is used. See [Create and Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information.
  * The invoices are sent only to the work email addresses or personal email addresses of the Bill To contact if the following conditions are all met:
    * The `useEmailTemplateSetting` field is set to `false`.
    * The email addresses are not specified in the `emailAddresses` field.


This operation makes an HTTP POST request to the `/v1/invoices/{invoiceId}/emails` endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Invoice Id | The ID of the 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.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

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

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

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


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


## Upload File for Invoice
`<mule-zuora-connector:create-v1-invoices-files-by-invoice-id>`
Uploads an externally generated invoice PDF file for an invoice that is in Draft or Posted status. This operation has the following restrictions: - Only the PDF file format is supported. - The maximum size of the PDF file to upload is 4 MB. - A maximum of 50 PDF files can be uploaded for one invoice. This operation makes an HTTP POST request to the /v1/invoices/{invoiceId}/files endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Invoice Id | The ID of the invoice that you want to upload a PDF file for. For example, 2c92c8955bd63cc1015bd7c151af02ab.  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
File Content | The content of the 'File' part. | #[payload]  
File Filename | The filename of the 'File' part (just the name, do not include path).  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream
| Configure how Mule processes streams with streaming strategies. Repeatable streams are the default behavior.  
Custom Query Parameters  
Custom Headers  
Response Timeout | The timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

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

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

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


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


## Create Summary Journal Entry
`<mule-zuora-connector:create-v1-journal-entries>`
This REST API reference describes how to manually create a summary journal entry. Request and response field descriptions and sample code are provided.
### Requirements
  1. The sum of debits must equal the sum of credits in the summary journal entry.
  2. The following applies only if you use foreign currency conversion:
     * If you have configured Aggregate transactions with different currencies during a Journal Run to "Yes", the value of the **currency** field must be the same as your tenant’s home currency. That is, you must create journal entries using your home currency.
     * All journal entries in an accounting period must be either all aggregated or all be unaggregated. You cannot have a mix of aggregated and unaggregated journal entries in the same accounting period.


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

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

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

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

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


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


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

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

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

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

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  Http Response Attributes  
---|---  
### For Configurations
  * Configurations
| 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: Create Account
`<mule-zuora-connector:create-v1-object-account>`
Creates an account without creating any associated objects such as subscriptions. This operation makes an HTTP POST request to the /v1/object/account endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Reject Unknown Fields | Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is: `json { "message": "Error - unrecognized fields" } ` By default, Zuora ignores unknown fields in the request body.  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

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

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

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


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


## CRUD: Create Bill Run
`<mule-zuora-connector:create-v1-object-bill-run>`
This feature is in **Limited Availability**. If you want access to this feature, submit a request to Zuora Global Support.   
---  
This operation creates an ad hoc bill run, or a single account, or multiple customer accounts. When creating a single account ad hoc bill run, your request must include `AccountId` and must not include `Batch` or `BillCycleDay`. If more than 500 bill runs are created using this operation are in Pending status, no more bill runs can be created by using this operation.
This operation makes an HTTP POST request to the /v1/object/bill-run endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Reject Unknown Fields | Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is: `json { "message": "Error - unrecognized fields" } ` By default, Zuora ignores unknown fields in the request body.  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

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

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

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

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

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

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


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


## CRUD: Create Contact
`<mule-zuora-connector:create-v1-object-contact>`
Creates a contact for a specified account.
This operation makes an HTTP POST request to the /v1/object/contact endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Reject Unknown Fields | Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is: `json { "message": "Error - unrecognized fields" } ` By default, Zuora ignores unknown fields in the request body.  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

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

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

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


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


## CRUD: Create CreditBalanceAdjustment
`<mule-zuora-connector:create-v1-object-credit-balance-adjustment>`
CRUD: Create CreditBalanceAdjustment This operation makes an HTTP POST request to the /v1/object/credit-balance-adjustment endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Reject Unknown Fields | Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is: `json { "message": "Error - unrecognized fields" } ` By default, Zuora ignores unknown fields in the request body.  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

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

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

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

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

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

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


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


## CRUD: Create Export
`<mule-zuora-connector:create-v1-object-export>`
Use this operation to create a data source export. After you have created a data source export, use [CRUD: Retrieve Export](https://www.zuora.com/developer/api-reference/#operation/Object_GETExport) to check the status of the data source export and access the exported data. When you export data from Zuora, each exported file is available for download for 7 days. Data source exports (Export objects) older than 90 days are automatically deleted. **Note:** This operation supports the [Export ZOQL](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL) query language. However, this operation does not support some data sources, objects, and fields in Export ZOQL queries. For full compatibility with Export ZOQL, Zuora recommends that you use the [AQuA API](https://knowledgecenter.zuora.com/DC_Developers/T_Aggregate_Query_API) instead of this operation. This operation makes an HTTP POST request to the /v1/object/export endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Reject Unknown Fields | Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is: `json { "message": "Error - unrecognized fields" } ` By default, Zuora ignores unknown fields in the request body.  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

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

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

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


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


## Object POSTFeature
`<mule-zuora-connector:create-v1-object-feature>`
This operation makes an HTTP POST request to the /v1/object/feature endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Reject Unknown Fields | Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is: `json { "message": "Error - unrecognized fields" } ` By default, Zuora ignores unknown fields in the request body.  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

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

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

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

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


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


## CRUD: Create Import
`<mule-zuora-connector:create-v1-object-import>`
Creates a data import. This operation makes an HTTP POST request to the /v1/object/import endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Reject Unknown Fields | Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is: `json { "message": "Error - unrecognized fields" } ` By default, Zuora ignores unknown fields in the request body.  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
Import Type Content | The content of the 'Import type' part. | #[payload]  
Name Content | The content of the 'Name' part.  
File Content | The content of the 'File' part.  
File Filename | The filename of the 'File' part (just the name, do not include path).  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

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

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

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


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


## CRUD: Create InvoiceAdjustment
`<mule-zuora-connector:create-v1-object-invoice-adjustment>`
CRUD: Create InvoiceAdjustment This operation makes an HTTP POST request to the /v1/object/invoice-adjustment endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Reject Unknown Fields | Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is: `json { "message": "Error - unrecognized fields" } ` By default, Zuora ignores unknown fields in the request body.  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

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

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

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

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

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

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


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


## CRUD: Create InvoicePayment
`<mule-zuora-connector:create-v1-object-invoice-payment>`
CRUD: Create InvoicePayment This operation makes an HTTP POST request to the /v1/object/invoice-payment endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Reject Unknown Fields | Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is: `json { "message": "Error - unrecognized fields" } ` By default, Zuora ignores unknown fields in the request body.  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

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

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

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


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


## CRUD: Create payment
`<mule-zuora-connector:create-v1-object-payment>`
Creates a payment. **Note:** If you have the Invoice Settlement feature enabled, you cannot use this operation to create a payment. This operation makes an HTTP POST request to the /v1/object/payment endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Reject Unknown Fields | Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is: `json { "message": "Error - unrecognized fields" } ` By default, Zuora ignores unknown fields in the request body.  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

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

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

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

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

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

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


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


## CRUD: Create Payment Method
`<mule-zuora-connector:create-v1-object-payment-method>`
This CRUD operation makes an HTTP POST request to the /v1/object/payment-method endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Reject Unknown Fields | Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is: `json { "message": "Error - unrecognized fields" } ` By default, Zuora ignores unknown fields in the request body.  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

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

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

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


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


## CRUD: Create Product
`<mule-zuora-connector:create-v1-object-product>`
This CRUD operation makes an HTTP POST request to the /v1/object/product endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Reject Unknown Fields | Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is: `json { "message": "Error - unrecognized fields" } ` By default, Zuora ignores unknown fields in the request body.  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

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

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

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

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

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

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


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


## CRUD: Create ProductRatePlan
`<mule-zuora-connector:create-v1-object-product-rate-plan>`
This CRUD operation makes an HTTP POST request to the /v1/object/product-rate-plan endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Reject Unknown Fields | Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is: `json { "message": "Error - unrecognized fields" } ` By default, Zuora ignores unknown fields in the request body.  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

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

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

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


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


## CRUD: Create product rate plan charge
`<mule-zuora-connector:create-v1-object-product-rate-plan-charge>`
Creates a product rate plan charge for a specified rate plan charge. Product rate plan charges can be of three types, one-time fees, recurring fees, and usage fees.
This operation makes an HTTP POST request to the /v1/object/product-rate-plan-charge endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Reject Unknown Fields | Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is: `json { "message": "Error - unrecognized fields" } ` By default, Zuora ignores unknown fields in the request body.  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

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

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

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

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

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

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


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


## CRUD: Create Refund
`<mule-zuora-connector:create-v1-object-refund>`
This CRUD operation makes an HTTP POST request to the /v1/object/refund endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Reject Unknown Fields | Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is: `json { "message": "Error - unrecognized fields" } ` By default, Zuora ignores unknown fields in the request body.  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

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

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

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


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


## CRUD: Create TaxationItem
`<mule-zuora-connector:create-v1-object-taxation-item>`
This CRUD operation makes an HTTP POST request to the /v1/object/taxation-item endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Reject Unknown Fields | Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is: `json { "message": "Error - unrecognized fields" } ` By default, Zuora ignores unknown fields in the request body.  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

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

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

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

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

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

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


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


## CRUD: Create UnitOfMeasure
`<mule-zuora-connector:create-v1-object-unit-of-measure>`
This CRUD operation makes an HTTP POST request to the /v1/object/unit-of-measure endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Reject Unknown Fields | Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is: `json { "message": "Error - unrecognized fields" } ` By default, Zuora ignores unknown fields in the request body.  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

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

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

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


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


## CRUD: Create usage
`<mule-zuora-connector:create-v1-object-usage>`
This CRUD operation makes an HTTP POST request to the /v1/object/usage endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Reject Unknown Fields | Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is: `json { "message": "Error - unrecognized fields" } ` By default, Zuora ignores unknown fields in the request body.  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

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

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

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

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

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

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


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


## Create Billing Preview
`<mule-zuora-connector:create-v1-operations-billing-preview>`
The Billing Preview feature is in **Limited Availability**. To have access to the feature, submit a request to Zuora Global Support.
This operation generates a preview of future invoice items for one customer account. Use the BillingPreview call to calculate how much a single customer is invoiced from the most recent invoice to a specific end of term date in the future. Additionally, you can use the BillingPreview service to access real-time data on an individual customer’s usage consumption. The BillingPreview call does not calculate taxes for charges in the subscription.
If you have the Invoice Settlement feature enabled, you can also generate a preview of future credit memo items for one customer account. The Invoice Settlement feature is in **Limited Availability**. To have access to the feature, submit a request to Zuora Global Support.
This operation makes an HTTP POST request to the `/v1/operations/billing-preview` endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

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

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

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


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


## Invoice and Collect
`<mule-zuora-connector:create-v1-operations-invoice-collect>`
Generates and posts invoices and credit memos and collects payments for posted invoices. Credit memos are only available if you have the Invoice Settlement feature enabled and negative charges exist. Credit memos will not be applied to invoices.
If draft invoices and credit memos exist when you run this operation, this operation will post the invoices and credit memos. Note that draft credit memos created from an invoice or a product rate plan charge will not be posted.
You can use this operation to generate invoices and collect payments on the posted invoices, or else simply collect payment on a specified existing invoice. The customer’s default payment method is used, and the full amount due is collected. The operation depends on the parameters you specify.
  * To generate one or more new invoices for that customer and collect payment on the generated and other unpaid invoice(s), leave the **invoiceId** field empty.
  * To collect payment on an existing invoice, specify the invoice ID. The operation is atomic; if any part is unsuccessful, the entire operation is rolled back. When an error occurs, gateway reason codes and error messages are returned the error response of this operation.
## Invoice and Collect
`<mule-zuora-connector:create-v1-operations-invoice-collect>`
Generates and posts invoices and credit memos and collects payments for posted invoices. Credit memos are only available if you have the Invoice Settlement feature enabled and negative charges exist. Credit memos will not be applied to invoices.
If draft invoices and credit memos exist when you run this operation, this operation will post the invoices and credit memos. Note that draft credit memos created from an invoice or a product rate plan charge will not be posted.
You can use this operation to generate invoices and collect payments on the posted invoices, or else simply collect payment on a specified existing invoice. The customer’s default payment method is used, and the full amount due is collected. The operation depends on the parameters you specify.
  * To generate one or more new invoices for that customer and collect payment on the generated and other unpaid invoice(s), leave the **invoiceId** field empty.
  * To collect payment on an existing invoice, specify the invoice ID. The operation is atomic; if any part is unsuccessful, the entire operation is rolled back. When an error occurs, gateway reason codes and error messages are returned the error response of this operation.


The following items are some gateway response code examples: * Orbital: `05 Do Not Honor`; `14 Invalid Credit Card Number` * Vantiv: `301 Invalid Account Number`; `304 Lost/Stolen Card` * CyberSource2: `202 Expired card`; `231 Invalid account number`
For more reason code information, see the corresponding payment gateway documentation.
Timeouts might occur when using this method on an account that has an extremely high number of subscriptions.   
---  
This operation makes an HTTP POST request to the `/v1/operations/invoice-collect` endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
Zuora version | The minor version of the Zuora REST API. You need to set this parameter if you use the following fields: * documentDate * targetDate If you have the Invoice Settlement feature enabled, you need to specify this parameter. Otherwise, an error is returned. See [Zuora REST API Versions](https://www.zuora.com/developer/api-reference/#section/API-Versions) for more information.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

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

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

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


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


## Create Order
`<mule-zuora-connector:create-v1-orders>`
This operation is only available if you have the Orders feature enabled. The migration to Orders is in **Limited Availability**. Feedback is being actively solicited from a small set of early adopters before releasing as generally available.   
---  
You can use this operation to create subscriptions and make changes to subscriptions by creating orders. The following tutorials demonstrate how to use this operation:
  * Add a Product to a Subscription
  *   *   * Change the Owner of a Subscription
  * Change the Terms and Conditions of a Subscription
  *   * Renew a Subscription and Upgrade a Product
  * Replace a Product in a Subscription
  * Update a Product in a Subscription
  *   * Remove a Product from a Subscription


Creating a draft order is currently not supported. See Known Limitations in Orders for additional limitations.
### Notes
  * When you suspend a subscription using the `suspend` order action, if, in the same "Create order" call, you are going to perform other subsequent order actions on the supscription to suspend, you must first resume the subscription using a `resume` order action.
  * When using this operation to create an account, create a subscription, run billing, and collect payment in a single call, if the payment processing fails then all the other steps are rolled back. This means that the invoice will not be generated, the subscription will not be created, and the account will not be created.


### Limits
Zuora has the following limits on orders to prevent performance degradation:
  * Up to 50 subscriptions are allowed in a single Create Order operation call.
  * Up to 50 order actions are allowed in a single Create Order operation call.
  * Up to 50 order actions are allowed on a single subscription in a Create Order operation call.


You can request a limit increase by submitting a request to Zuora Global Support.
This operation makes an HTTP POST request to the /v1/orders endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Return Ids | Specify whether to return IDs associated with the numbers returned in the Create Order operation.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
Zuora version | The minor version of the Zuora REST API. You need to set this parameter if you use the following fields: * subscriptions * subscriptionNumbers  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

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

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

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


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


## Preview Order
`<mule-zuora-connector:create-v1-orders-preview>`
This operation is only available if you have the Orders feature enabled.   
---  
The migration to Orders is in **Limited Availability**. Feedback is being actively solicited from a small set of early adopters before releasing as generally available.
This operation retrieves the preview of the charge metrics and invoice items of a specified order. This operation is only an order preview and no order is created.
### Limits
Zuora has the following limits on Orders to prevent performance degradation:
  * Up to 50 subscriptions are allowed in a single Preview Order operation call.
  * Up to 50 order actions are allowed in a single PPreview Order operation call.
  * Up to 50 order actions are allowed on a single subscription in a Preview Order operation call.


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

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

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

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

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


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


## Create Payment Method
`<mule-zuora-connector:create-v1-payment-methods>`
You can use this operation to create a payment method for a customer account.
This operation supports the payment methods listed below:
  * PayPal Express Checkout The following required request body fields are specific to this payment method:
    * `BAID` (required)
    * `email` (required)
  * PayPal Native Express Checkout The following required request body fields are specific to this payment method:
    * `BAID` (required)
    * `email` (optional)
  * PayPal Adaptive The following required request body fields are specific to this payment method:
    * `preapprovalKey` (required)
    * `email` (required)
  * Credit Card This feature is in **Limited Availability**. Feedback is being actively solicited from a small set of early adopters before being released for general availability. The following request body fields are specific to this payment method:
    * `cardHolderInfo` (`cardHolderName` required)
    * `cardNumber` (required)
    * `cardType` (required)
    * `expirationMonth` (required)
    * `expirationYear` (required)
    * `mitConsentAgreementRef`
    * `mitConsentAgreementSrc`
    * `mitNetworkTransactionId`
    * `mitProfileAction`
    * `mitProfileType`
    * `mitProfileAgreedOn`
    * `securityCode`
    * `checkDuplicated`
  * ACH The following request body fields are applicable to this payment method:
    * `bankABACode` (required)
    * `bankAccountName` (required)
    * `bankAccountNumber` (required)
    * `bankAccountType` (required)
    * `bankName` (required)
    * `addressLine1`
    * `addressLine2`
    * `country`
    * `zipCode`
  * SEPA
The following request body fields are applicable to this payment method:
    * `IBAN` (required)
    * `accountHolderInfo` (required)
    * `businessIdentificationCode`
  * Betalingsservice (Direct Debit DK) The following request body fields are applicable to this payment method:
    * `accountNumber` (required)
    * `identityNumber` (required)
    * `bankCode` (required)
    * `accountHolderInfo` (required)
  * Autogiro (Direct Debit SE) The following request body fields are applicable to this payment method:
    * `accountNumber` (required)
    * `identityNumber` (required)
    * `branchCode` (required)
    * `accountHolderInfo` (required)
  * Bacs (Direct Debit UK) The following request body fields are applicable to this payment method:
    * `accountNumber` (required)
    * `bankCode` (required)
    * `accountHolderInfo` (required)
This operation makes an HTTP POST request to the /v1/payment-methods endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

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

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

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


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


## Create Authorization
`<mule-zuora-connector:create-v1-payment-methods-authorize-by-payment-method-id>`
If you want this feature enabled, submit a request to Zuora Global Support.   
---  
This operation enables you to authorize the availability of funds for a transaction but delay the capture of funds until a later time. You can subsequently use CRUD: Create payment or Create payment to capture the authorized funds, or use Cancel authorization to cancel the authorization.
The payment gateways that support this operation include Verifi, CyberSource 1.28, CyberSource 1.97, Chase Paymentech Orbital, and Ingenico ePayments.
If you have the Invoice Settlement feature enabled, use the Create payment operation to capture the funds instead of the CRUD: Create payment operation.
This operation makes an HTTP POST request to the /v1/payment-methods/{payment-method-id}/authorize endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Payment method id | The unique ID of the payment method where the authorization is created.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

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

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

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


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


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


## Create Credit Card Payment Method
`<mule-zuora-connector:create-v1-payment-methods-credit-cards>`
This REST API reference describes how to create a new credit card payment method for a customer account. This API call is CORS Enabled. Use client-side JavaScript to invoke the call.
If you use this operation to create credit card payment methods instead of using the iFrame of Hosted Payment Pages, you are subject to PCI-compliance audit requirements.   
---  
This operation makes an HTTP POST request to the /v1/payment-methods/credit-cards endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

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

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

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


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


## Create Apple Pay Payment Method
`<mule-zuora-connector:create-v1-payment-methods-decryption>`
The decryption API endpoint can conditionally perform three tasks in one atomic call:
  * Decrypt Apple Pay Payment token
  * Create Credit Card Payment Method in Zuora with decrypted Apple Pay information
  * Process Payment on a specified Invoice (optional)


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

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

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

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

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


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


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


## Create Stored Credential Profile
`<mule-zuora-connector:create-v1-payment-methods-profiles-by-payment-method-id>`
Creates a stored credential profile within a payment method. The stored credential profile represents a consent agreement that you have established with a customer. When you use the payment method in a transaction, Zuora might include information from the stored credential profile to inform the payment processor that the transaction is related to your pre-existing consent agreement with the customer.
This feature is in **Limited Availability**. Feedback is being actively solicited from a small set of early adopters before releasing as generally available.   
---  
This operation makes an HTTP POST request to the /v1/payment-methods/{payment-method-id}/profiles endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Payment method id | ID of a payment method.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

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

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

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


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


## Cancel Stored Credential Profile
`<mule-zuora-connector:create-v1-payment-methods-profiles-cancel-by-payment-method-id-profile-number>`
Cancels a stored credential profile within a payment method. Cancelling the stored credential profile indicates that the stored credentials are no longer valid, per a customer request. You cannot reactivate the stored credential profile after you have cancelled it.
This feature is in **Limited Availability**. Feedback is being actively solicited from a small set of early adopters before releasing as generally available.   
---  
This operation makes an HTTP POST request to the /v1/payment-methods/{payment-method-id}/profiles/{profile-number}/cancel endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Payment method id | ID of a payment method.  
Profile number | Number that identifies a stored credential profile within the payment method.  
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 automatically assigns 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


## Expire Stored Credential Profile
`<mule-zuora-connector:create-v1-payment-methods-profiles-expire-by-payment-method-id-profile-number>`
Expires a stored credential profile within a payment method. Expiring the stored credential profile indicates that the stored credentials are no longer valid, per an expiration policy in the stored credential transaction framework. You cannot reactivate the stored credential profile after they are expired.
This feature is in **Limited Availability**. Feedback is being actively solicited from a small set of early adopters before releasing for general availability.   
---  
This operation makes an HTTP POST request to the /v1/payment-methods/{payment-method-id}/profiles/{profile-number}/expire endpoint
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Payment method id | ID of a payment method.  
Profile number | Number that identifies a stored credential profile within the payment method.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
Zuora Entity Ids | An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

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

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

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


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


## Cancel Authorization
`<mule-zuora-connector:create-v1-payment-methods-void-authorize-by-payment-method-id>`
If you want this feature enabled, submit a request to Zuora Global Support.   
---  
This operation allows you to cancel an authorization. The payment gateways that support this operation include Verifi, CyberSource 1.28, CyberSource 1.97, Chase Paymentech Orbital, and Ingenico ePayments.
This operation makes an HTTP POST request to the /v1/payment-methods/{payment-method-id}/voidAuthorize endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Payment method id | The unique ID of the payment method where the authorization is cancelled.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

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

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

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


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


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


## Create Payment Run
`<mule-zuora-connector:create-v1-payment-runs>`
Creates a payment run. You can create a payment run to execute immediately after it is created, or a scheduced payment run to execute in future. The `accountId`, `batch`, `billCycleDay`, `currency`, `paymentGatewayId`, and `billingRunId` fields are used to determine which receivables to be paid in the payment run. If none of these fields is specified in the request body, the corresponding payment run collects payments for all accounts.
This operation makes an HTTP POST request to the /v1/payment-runs endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

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

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

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


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


## Create Payment
`<mule-zuora-connector:create-v1-payments>`
The Invoice Settlement feature is in **Limited Availability**. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want access to the feature, submit a request to Zuora Global Support.
This operation creates a payment for the following scenarios:
  * A full payment on an invoice or debit memo
  * A partial payment
  * A payment for several invoices and debit memos
  * An unapplied payment If you do not know to which customer account the payment belongs, you can create a payment without specifying a customer account.


When creating a payment, the total number of invoices and debit memos that the payment applies to must be less than or equal to 1,000.
If the Proration application rule is used when creating a payment, the following quantity must be less than or equal to 10,000: `(number of invoice items + number of debit memo items) * number of payment items`
Otherwise, the First In First Out rule is used instead of the Proration rule.
For more information, see Create Payments and Create Payments Without Specifying Customer Accounts.
This operation makes an HTTP POST request to the /v1/payments endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Zuora Track Id | A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`).  
Zuora Entity Ids | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

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

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

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

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