QuickBooks Online Connector 2.0 Reference - Mule 4
Configurations
Config
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Name |
String |
The name for this configuration. Connectors reference the configuration with this name. |
x |
|
Connection |
The connection types to provide to this configuration. |
x |
||
Response Timeout |
Number |
The timeout for request to the remote service. |
1 |
|
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
MINUTES |
|
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
AUTO |
|
Name |
String |
The identifier of this element used to reference it in other components |
x |
|
Expiration Policy |
Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate. |
Connection Types
Auth Connection Provider
Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to Configuring OAuth 2.0 for Connectors or Configuring OAuth 2.0 for Connectors on CloudHub.
Parameters
Name | Type | Description | Default Value | Required | ||
---|---|---|---|---|---|---|
Default Headers |
Array of Default Header |
|||||
Query Parameters |
Array of Default Query Param |
|||||
Connection Timeout |
Number |
The timeout for establishing connections to the remote service |
30 |
|||
Connection Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Connection Timeout |
SECONDS |
|||
Use Persistent Connections |
Boolean |
If false, each connection will be closed after the first request is completed. |
true |
|||
Max Connections |
Number |
The maximum number of outbound connections to keep open at the same time |
-1 |
|||
Connection Idle Timeout |
Number |
A timeout for how long a connection can remain idle before it is closed |
30 |
|||
Connection Idle Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the connection Idle Timeout |
SECONDS |
|||
Proxy Config |
Reusable configuration element for outbound connections through a proxy |
|||||
Stream Response |
Boolean |
Whether or not received responses should be streamed |
false |
|||
Response Buffer Size |
Number |
The space in bytes for the buffer where the HTTP response will be stored. |
-1 |
|||
Base Uri |
String |
Parameter base URI, each instance/tenant gets its own |
||||
State |
String |
A String value that you send when the OAuth dance is initiated and that is returned back by the service provider with the token callback.
|
security_token |
|||
TLS Configuration |
||||||
Reconnection |
When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy. |
|||||
Consumer Key |
String |
The OAuth consumerKey as registered with the service provider |
x |
|||
Consumer Secret |
String |
The OAuth consumerSecret as registered with the service provider |
x |
|||
Authorization Url |
String |
The service provider’s authorization endpoint URL |
||||
Access Token Url |
String |
The service provider’s accessToken endpoint URL |
||||
Scopes |
String |
The OAuth scopes to be requested during the dance. If not provided, it defaults to those in the annotation |
||||
Resource Owner Id |
String |
The resourceOwnerId which each component should use if it doesn’t reference otherwise. |
||||
Before |
String |
The name of a flow to execute right before starting the OAuth dance |
||||
After |
String |
The name of a flow to execute right after an accessToken has been received |
||||
Listener Config |
String |
A reference to a <http:listener-config /> to use to create the listener that will catch the access token callback endpoint. |
x |
|||
Callback Path |
String |
The path of the access token callback endpoint |
x |
|||
Authorize Path |
String |
The path of the local http endpoint which triggers the OAuth dance |
x |
|||
External Callback Url |
String |
If the callback endpoint is behind a proxy or should be accessed through a non direct URL, use this parameter to tell the OAuth provider the URL it should use to access the callback |
||||
Object Store |
String |
A reference to the object store that should be used to store each resource owner id’s data. If not specified, runtime will automatically provision the default one. |
Get account by account id
<quickbooks-online-connector-mule-4:account1get>
Retrieve an account by Id This operation makes an HTTP GET request to the /account/{accountId} endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
Account Id |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Create account
<quickbooks-online-connector-mule-4:account-post2>
Create a new Account This operation makes an HTTP POST request to the /account endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Create account update
<quickbooks-online-connector-mule-4:account-update>
Update a new Account This operation makes an HTTP POST request to the /account/update endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get attachable by attachable id
<quickbooks-online-connector-mule-4:attachable5000000000000029383get>
Retrieve an attachable object by Id This operation makes an HTTP GET request to the /attachable/{attachableId} endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Attachable Id |
String |
Attachable Id |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Create attachable
<quickbooks-online-connector-mule-4:attachable-post3>
Create an attachable object This operation makes an HTTP POST request to the /attachable endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Create batch
<quickbooks-online-connector-mule-4:batch-post>
Multiple operations using batch query This operation makes an HTTP POST request to the /batch endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get bill by bill id
<quickbooks-online-connector-mule-4:bill1get>
Retrieve a bill by Id This operation makes an HTTP GET request to the /bill/{billId} endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Bill Id |
String |
Bill Id |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Create bill
<quickbooks-online-connector-mule-4:bill-post3>
Create a bill This operation makes an HTTP POST request to the /bill endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get billpayment by billpayment id
<quickbooks-online-connector-mule-4:billpayment118get>
Retrieve Bill Payment by Id This operation makes an HTTP GET request to the /billpayment/{billpaymentId} endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Billpayment Id |
String |
Billpayment Id |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Create billpayment
<quickbooks-online-connector-mule-4:billpayment-post3>
Update a Bill Payment This operation makes an HTTP POST request to the /billpayment endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get cdc
<quickbooks-online-connector-mule-4:cdc-get>
Retrieve changed Bill and invoice objects This operation makes an HTTP GET request to the /cdc endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
entities |
String |
entities |
x |
|
Changed Since |
String |
Changed Since |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get class by class id
<quickbooks-online-connector-mule-4:class5000000000000018727get>
Read a Class object by Id This operation makes an HTTP GET request to the /class/{classId} endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Class Id |
String |
Class Id |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Create class
<quickbooks-online-connector-mule-4:class-post3>
Create a Class object This operation makes an HTTP POST request to the /class endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get companyinfo by company id
<quickbooks-online-connector-mule-4:companyinfo-by-companyid-get>
Get company info This operation makes an HTTP GET request to the /companyinfo/{companyId} endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
companyid |
String |
companyid |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get creditmemo by creditmemo id
<quickbooks-online-connector-mule-4:creditmemo160get>
Read a credit memo by Id This operation makes an HTTP GET request to the /creditmemo/{creditmemoId} endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Creditmemo Id |
String |
Creditmemo Id |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Create creditmemo
<quickbooks-online-connector-mule-4:creditmemo-post3>
Update a credit memo This operation makes an HTTP POST request to the /creditmemo endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get customer by customer id
<quickbooks-online-connector-mule-4:customer63get>
Read a customer entry by Id This operation makes an HTTP GET request to the /customer/{customerId} endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Customer Id |
String |
Customer Id |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Create customer
<quickbooks-online-connector-mule-4:customer-post3>
Create a customer This operation makes an HTTP POST request to the /customer endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get department by department id
<quickbooks-online-connector-mule-4:department1get>
Read a department object This operation makes an HTTP GET request to the /department/{departmentId} endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Department Id |
String |
Department Id |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Create department
<quickbooks-online-connector-mule-4:department-post3>
Create a department object This operation makes an HTTP POST request to the /department endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get deposit by deposit id
<quickbooks-online-connector-mule-4:deposit162get>
Read a deposit object by Id This operation makes an HTTP GET request to the /deposit/{depositId} endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Deposit Id |
String |
Deposit Id |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Create deposit
<quickbooks-online-connector-mule-4:deposit-post3>
Update a deposit object This operation makes an HTTP POST request to the /deposit endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get employee by employee id
<quickbooks-online-connector-mule-4:employee68get>
Retrieve an employee object by Id This operation makes an HTTP GET request to the /employee/{employeeId} endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Employee Id |
String |
Employee Id |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Create employee
<quickbooks-online-connector-mule-4:employee-post3>
Delete an employee object This operation makes an HTTP POST request to the /employee endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
User Agent |
String |
User Agent |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get estimate by estimate id
<quickbooks-online-connector-mule-4:estimate163get>
Read an Estimate object by Id This operation makes an HTTP GET request to the /estimate/{estimateId} endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Estimate Id |
String |
Estimate Id |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Create estimate
<quickbooks-online-connector-mule-4:estimate-post3>
Update an Estimate object This operation makes an HTTP POST request to the /estimate endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get exchangerate
<quickbooks-online-connector-mule-4:exchangerate-get>
Get Exchange Rate This operation makes an HTTP GET request to the /exchangerate endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
sourcecurrencycode |
String |
sourcecurrencycode |
x |
|
asofdate |
String |
asofdate |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get invoice by invoice id
<quickbooks-online-connector-mule-4:invoice147get>
Read an invoice object by Id This operation makes an HTTP GET request to the /invoice/{invoiceId} endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Invoice Id |
String |
Invoice Id |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Create invoice
<quickbooks-online-connector-mule-4:invoice-post4>
Create an invoice object This operation makes an HTTP POST request to the /invoice endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get item by item id
<quickbooks-online-connector-mule-4:item-idget>
Read an Item by Id This operation makes an HTTP GET request to the /item/{itemId} endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Item Id |
String |
Item Id |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Create item
<quickbooks-online-connector-mule-4:item-post3>
Create an item object This operation makes an HTTP POST request to the /item endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get journalentry by journalentry id
<quickbooks-online-connector-mule-4:journalentry8get>
Read a journal entry object by Id This operation makes an HTTP GET request to the /journalentry/{journalentryId} endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Journalentry Id |
String |
Journalentry Id |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Create journalentry
<quickbooks-online-connector-mule-4:journalentry-post3>
Create a journal entry object This operation makes an HTTP POST request to the /journalentry endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get payment by payment id
<quickbooks-online-connector-mule-4:payment174get>
Read a payment object by Id This operation makes an HTTP GET request to the /payment/{paymentId} endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Payment Id |
String |
Payment Id |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Create payment
<quickbooks-online-connector-mule-4:payment-post3>
Create a payment object This operation makes an HTTP POST request to the /payment endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get paymentmethod by paymentmethod id
<quickbooks-online-connector-mule-4:paymentmethod8get>
Read a payment method This operation makes an HTTP GET request to the /paymentmethod/{paymentmethodId} endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Paymentmethod Id |
String |
Paymentmethod Id |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Create paymentmethod
<quickbooks-online-connector-mule-4:paymentmethod-post3>
Update a payment method This operation makes an HTTP POST request to the /paymentmethod endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get preferences
<quickbooks-online-connector-mule-4:preferences-get>
Read the preference object This operation makes an HTTP GET request to the /preferences endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Create preferences
<quickbooks-online-connector-mule-4:preferences-post>
Update the preference object endpoint This operation makes an HTTP POST request to the /preferences endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get purchase by purchase id
<quickbooks-online-connector-mule-4:purchase175get>
Read a puchase object by Id This operation makes an HTTP GET request to the /purchase/{purchaseId} endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Purchase Id |
String |
Purchase Id |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Create purchase
<quickbooks-online-connector-mule-4:purchase-post3>
Create a purchase object This operation makes an HTTP POST request to the /purchase endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get purchaseorder by purchaseorder id
<quickbooks-online-connector-mule-4:purchaseorder178get>
Read a purchase-order object This operation makes an HTTP GET request to the /purchaseorder/{purchaseorderId} endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Purchaseorder Id |
String |
Purchaseorder Id |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Create purchaseorder
<quickbooks-online-connector-mule-4:purchaseorder-post3>
Create a purchase-order object This operation makes an HTTP POST request to the /purchaseorder endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get query
<quickbooks-online-connector-mule-4:query-post32>
Read all transfer objects using the Query endpoint This operation makes an HTTP GET request to the /query endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
query |
String |
query |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get refundreceipt by refundreceipt id
<quickbooks-online-connector-mule-4:refundreceipt66get>
Read a refund-receipt object This operation makes an HTTP GET request to the /refundreceipt/{refundreceiptId} endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Refundreceipt Id |
String |
Refundreceipt Id |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Create refundreceipt
<quickbooks-online-connector-mule-4:refundreceipt-post3>
Update a refund-receipt object This operation makes an HTTP POST request to the /refundreceipt endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get reports account list
<quickbooks-online-connector-mule-4:reports-account-list-get>
Report - Account list detail This operation makes an HTTP GET request to the /reports/AccountList endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get reports aged payable detail
<quickbooks-online-connector-mule-4:reports-aged-payable-detail-get>
Report - Aged Payable aging detail This operation makes an HTTP GET request to the /reports/AgedPayableDetail endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get reports aged payables
<quickbooks-online-connector-mule-4:reports-aged-payables-get>
Report - Aged Payable aging summary This operation makes an HTTP GET request to the /reports/AgedPayables endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get reports aged receivable detail
<quickbooks-online-connector-mule-4:reports-aged-receivable-detail-get>
Report - Aged Receivable Detail aging detail This operation makes an HTTP GET request to the /reports/AgedReceivableDetail endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get reports aged receivables
<quickbooks-online-connector-mule-4:reports-aged-receivables-get>
Report - Aged Receivable aging summary This operation makes an HTTP GET request to the /reports/AgedReceivables endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get reports balance sheet
<quickbooks-online-connector-mule-4:reports-balance-sheet-get>
Report - Balance Sheet This operation makes an HTTP GET request to the /reports/BalanceSheet endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get reports cash flow
<quickbooks-online-connector-mule-4:reports-cash-flow-get>
Report - Cash Flow This operation makes an HTTP GET request to the /reports/CashFlow endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get reports class sales
<quickbooks-online-connector-mule-4:reports-class-sales-get>
Report - Cash Sales This operation makes an HTTP GET request to the /reports/ClassSales endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get reports customer balance detail
<quickbooks-online-connector-mule-4:reports-customer-balance-detail-get>
Report - Customer Balance Detail This operation makes an HTTP GET request to the /reports/CustomerBalanceDetail endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get reports customer balance
<quickbooks-online-connector-mule-4:reports-customer-balance-get>
Report - Customer Balance This operation makes an HTTP GET request to the /reports/CustomerBalance endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get reports customer income
<quickbooks-online-connector-mule-4:reports-customer-income-get>
Report - Customer Income This operation makes an HTTP GET request to the /reports/CustomerIncome endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get reports customer sales
<quickbooks-online-connector-mule-4:reports-customer-sales-get>
Report - Customer Sales This operation makes an HTTP GET request to the /reports/CustomerSales endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get reports department sales
<quickbooks-online-connector-mule-4:reports-department-sales-get>
Report - Department Sales This operation makes an HTTP GET request to the /reports/DepartmentSales endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get reports general ledger
<quickbooks-online-connector-mule-4:reports-general-ledger-get>
Report - General Ledger This operation makes an HTTP GET request to the /reports/GeneralLedger endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get reports inventory valuation summary
<quickbooks-online-connector-mule-4:reports-inventory-valuation-summary-get>
Report - Inventory Valuation Summary This operation makes an HTTP GET request to the /reports/InventoryValuationSummary endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get reports item sales
<quickbooks-online-connector-mule-4:reports-item-sales-get>
Report - Item Sales This operation makes an HTTP GET request to the /reports/ItemSales endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get reports profit and loss detail
<quickbooks-online-connector-mule-4:reports-profit-and-loss-detail-get>
Report - Profit and Loss Detail This operation makes an HTTP GET request to the /reports/ProfitAndLossDetail endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get reports profit and loss
<quickbooks-online-connector-mule-4:reports-profit-and-loss-get>
Report - Profit and Loss This operation makes an HTTP GET request to the /reports/ProfitAndLoss endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get reports transaction list
<quickbooks-online-connector-mule-4:reports-transaction-list-get>
Report - Trial List This operation makes an HTTP GET request to the /reports/TransactionList endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get reports trial balance
<quickbooks-online-connector-mule-4:reports-trial-balance-get>
Report - Trial Balance This operation makes an HTTP GET request to the /reports/TrialBalance endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get reports vendor balance detail
<quickbooks-online-connector-mule-4:reports-vendor-balance-detail-get>
Report - Vendor Balance Detail This operation makes an HTTP GET request to the /reports/VendorBalanceDetail endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get reports vendor balance
<quickbooks-online-connector-mule-4:reports-vendor-balance-get>
Report - Vendor Balance This operation makes an HTTP GET request to the /reports/VendorBalance endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get reports vendor expenses
<quickbooks-online-connector-mule-4:reports-vendor-expenses-get>
Report - Vendor Expense This operation makes an HTTP GET request to the /reports/VendorExpenses endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get salesreceipt by salesreceipt id
<quickbooks-online-connector-mule-4:salesreceipt181get>
Create a sales receipt object This operation makes an HTTP GET request to the /salesreceipt/{salesreceiptId} endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Salesreceipt Id |
String |
Salesreceipt Id |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Create salesreceipt
<quickbooks-online-connector-mule-4:salesreceipt-post4>
Create an sales receipt object This operation makes an HTTP POST request to the /salesreceipt endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get taxagency by taxagency id
<quickbooks-online-connector-mule-4:taxagency3get>
Get a tax-agency object by Id This operation makes an HTTP GET request to the /taxagency/{taxagencyId} endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Taxagency Id |
String |
Taxagency Id |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Create taxagency
<quickbooks-online-connector-mule-4:taxagency-post>
Create a tax-agency object This operation makes an HTTP POST request to the /taxagency endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get taxcode by taxcode id
<quickbooks-online-connector-mule-4:taxcode2get>
Read a tax code by Id This operation makes an HTTP GET request to the /taxcode/{taxcodeId} endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Taxcode Id |
String |
Taxcode Id |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get taxrate by taxrate id
<quickbooks-online-connector-mule-4:taxrate1get>
Read a tax rate by Id This operation makes an HTTP GET request to the /taxrate/{taxrateId} endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Taxrate Id |
String |
Taxrate Id |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Create taxservice taxcode
<quickbooks-online-connector-mule-4:taxservice-taxcode-post>
Use Tax Service to create tax code and corresponding tax rates This operation makes an HTTP POST request to the /taxservice/taxcode endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get term by term id
<quickbooks-online-connector-mule-4:term8get>
Read a term object by Id This operation makes an HTTP GET request to the /term/{termId} endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Term Id |
String |
Term Id |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Create term
<quickbooks-online-connector-mule-4:term-post3>
Update a term object This operation makes an HTTP POST request to the /term endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
User Agent |
String |
User Agent |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Create timeactivity
<quickbooks-online-connector-mule-4:timeactivity-post4>
Create a term object This operation makes an HTTP POST request to the /timeactivity endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get transfer by transfer id
<quickbooks-online-connector-mule-4:transfer184get>
Read a transfer object by Id This operation makes an HTTP GET request to the /transfer/{transferId} endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Transfer Id |
String |
Transfer Id |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Create transfer
<quickbooks-online-connector-mule-4:transfer-post3>
Create a transfer object This operation makes an HTTP POST request to the /transfer endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Unauthorize
<quickbooks-online-connector-mule-4:unauthorize>
Deletes all the access token information of a given resource owner ID so that it’s impossible to execute any operation for that user without doing the authorization dance again
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Resource Owner Id |
String |
The ID of the resource owner which access should be invalidated |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
Create upload
<quickbooks-online-connector-mule-4:upload-post>
Uploading and linking new attachments This operation makes an HTTP POST request to the /upload endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
File _ content _ 0 - Body |
String |
The content of the 'File content 0' part. |
#[payload] |
|
File content 0 Filename |
String |
The filename of the 'File content 0' part (just the name, do not include path). |
x |
|
File _ metadata _ 0 - Body |
Any |
The content of the 'File metadata 0' part. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get vendor by vendor id
<quickbooks-online-connector-mule-4:vendor70get>
Read a vendor object by Id This operation makes an HTTP GET request to the /vendor/{vendorId} endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Vendor Id |
String |
Vendor Id |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Create vendor
<quickbooks-online-connector-mule-4:vendor-post3>
Update a vendor object This operation makes an HTTP POST request to the /vendor endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Get vendorcredit by vendorcredit id
<quickbooks-online-connector-mule-4:vendorcredit185get>
Read a vendor credit object by Id This operation makes an HTTP GET request to the /vendorcredit/{vendorcreditId} endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Vendorcredit Id |
String |
Vendorcredit Id |
x |
|
minorversion |
String |
minorversion |
x |
|
User Agent |
String |
User Agent |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Create vendorcredit
<quickbooks-online-connector-mule-4:vendorcredit-post3>
Delete a vendor credit object by Id This operation makes an HTTP POST request to the /vendorcredit endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
operation |
String |
operation |
x |
|
User Agent |
String |
User Agent |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the Response Timeout} |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:BAD_REQUEST
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CLIENT_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:CONNECTIVITY
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:NOT_FOUND
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVER_ERROR
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TIMEOUT
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNAUTHORIZED
-
QUICKBOOKS-ONLINE-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
On new customer
<quickbooks-online-connector-mule-4:on-new-customer-trigger>
Triggers an event for every new customer.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Created time |
String |
Returns the results of the query from a given timestamp. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
x |
|
Primary Node Only |
Boolean |
Determines whether to execute this source on only the primary node when running Mule instances in a cluster. |
||
Scheduling Strategy |
scheduling-strategy |
Configures the scheduler that triggers the polling. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Redelivery Policy |
RedeliveryPolicy |
Defines a policy for processing the redelivery of the same message. |
||
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
On new invoice
<quickbooks-online-connector-mule-4:on-new-invoice-trigger>
Triggers an event for every new invoice.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Created time |
String |
Returns the results of the query from a given timestamp. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
x |
|
Primary Node Only |
Boolean |
Determines whether to execute this source on only the primary node when running Mule instances in a cluster. |
||
Scheduling Strategy |
scheduling-strategy |
Configures the scheduler that triggers the polling. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Redelivery Policy |
RedeliveryPolicy |
Defines a policy for processing the redelivery of the same message. |
||
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
On new item
<quickbooks-online-connector-mule-4:on-new-item-trigger>
Triggers an event for every new item.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Created time |
String |
Returns the results of the query from a given timestamp. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
x |
|
Primary Node Only |
Boolean |
Determines whether to execute this source on only the primary node when running Mule instances in a cluster. |
||
Scheduling Strategy |
scheduling-strategy |
Configures the scheduler that triggers the polling. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Redelivery Policy |
RedeliveryPolicy |
Defines a policy for processing the redelivery of the same message. |
||
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
On updated customer
<quickbooks-online-connector-mule-4:on-updated-customer-trigger>
Triggers an event for every updated customer.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Last Updated Time |
String |
Returns the results of the query from a given timestamp. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
x |
|
Primary Node Only |
Boolean |
Determines whether to execute this source on only the primary node when running Mule instances in a cluster. |
||
Scheduling Strategy |
scheduling-strategy |
Configures the scheduler that triggers the polling. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Redelivery Policy |
RedeliveryPolicy |
Defines a policy for processing the redelivery of the same message. |
||
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
On updated invoice
<quickbooks-online-connector-mule-4:on-updated-invoice-trigger>
Triggers an event for every updated invoice.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Last Updated Time |
String |
Returns the results of the query from a given timestamp. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
x |
|
Primary Node Only |
Boolean |
Determines whether to execute this source on only the primary node when running Mule instances in a cluster. |
||
Scheduling Strategy |
scheduling-strategy |
Configures the scheduler that triggers the polling. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Redelivery Policy |
RedeliveryPolicy |
Defines a policy for processing the redelivery of the same message. |
||
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
On updated item
<quickbooks-online-connector-mule-4:on-updated-item-trigger>
Triggers an event for every updated item.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Last Updated Time |
String |
Returns the results of the query from a given timestamp. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration used to execute this component. |
x |
|
Primary Node Only |
Boolean |
Determines whether to execute this source on only the primary node when running Mule instances in a cluster. |
||
Scheduling Strategy |
scheduling-strategy |
Configures the scheduler that triggers the polling. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Redelivery Policy |
RedeliveryPolicy |
Defines a policy for processing the redelivery of the same message. |
||
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Types
Proxy
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Host |
String |
x |
||
Port |
Number |
x |
||
Username |
String |
|||
Password |
String |
|||
Non Proxy Hosts |
String |
Tls
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Enabled Protocols |
String |
A comma-separated list of protocols enabled for this context. |
||
Enabled Cipher Suites |
String |
A comma-separated list of cipher suites enabled for this context. |
||
Trust Store |
||||
Key Store |
||||
Revocation Check |
Trust Store
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Path |
String |
The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store. |
||
Password |
String |
The password used to protect the trust store. |
||
Type |
String |
The type of store used. |
||
Algorithm |
String |
The algorithm used by the trust store. |
||
Insecure |
Boolean |
If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk. |
Key Store
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Path |
String |
The location (which will be resolved relative to the current classpath and file system, if possible) of the key store. |
||
Type |
String |
The type of store used. |
||
Alias |
String |
When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default. |
||
Key Password |
String |
The password used to protect the private key. |
||
Password |
String |
The password used to protect the key store. |
||
Algorithm |
String |
The algorithm used by the key store. |
Standard Revocation Check
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Only End Entities |
Boolean |
Only verify the last element of the certificate chain. |
||
Prefer Crls |
Boolean |
Try CRL instead of OCSP first. |
||
No Fallback |
Boolean |
Do not use the secondary checking method (the one not selected before). |
||
Soft Fail |
Boolean |
Avoid verification failure when the revocation server can not be reached or is busy. |
Custom Ocsp Responder
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Url |
String |
The URL of the OCSP responder. |
||
Cert Alias |
String |
Alias of the signing certificate for the OCSP response (must be in the trust store), if present. |
Reconnection
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Fails Deployment |
Boolean |
When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy. |
||
Reconnection Strategy |
The reconnection strategy to use. |
Reconnect
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Frequency |
Number |
How often in milliseconds to reconnect |
||
Blocking |
Boolean |
If false, the reconnection strategy will run in a separate, non-blocking thread |
||
Count |
Number |
How many reconnection attempts to make. |
Reconnect Forever
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Frequency |
Number |
How often in milliseconds to reconnect |
||
Blocking |
Boolean |
If false, the reconnection strategy will run in a separate, non-blocking thread |
Expiration Policy
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Max Idle Time |
Number |
A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration |
||
Time Unit |
Enumeration, one of:
|
A time unit that qualifies the maxIdleTime attribute |
Http Response Attributes
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Status Code |
Number |
x |
||
Headers |
Object |
x |
||
Reason Phrase |
String |
x |
Repeatable In Memory Stream
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Initial Buffer Size |
Number |
The amount of memory that will be allocated to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. |
||
Buffer Size Increment |
Number |
This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. |
||
Max Buffer Size |
Number |
The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which all these attributes are expressed |
Repeatable File Store Stream
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
In Memory Size |
Number |
Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed content on the disk is buffered. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which maxInMemorySize is expressed |