QuickBooks Online Connector 1.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	Auth Connection Provider	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: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit which qualifies the Response Timeout}	MINUTES
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.	AUTO
Name	String	The identifier of this element used to reference it in other components		x
Expiration Policy	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.

Name

Type

Description

Default Value

Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

Auth Connection Provider

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

MINUTES

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

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

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: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	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: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit which qualifies the connection Idle Timeout	SECONDS
Proxy Config	Proxy	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	https://sandbox-quickbooks.api.intuit.com
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	Tls
Reconnection	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	https://appcenter.intuit.com/connect/oauth2
Access Token Url	String	The service provider’s accessToken endpoint URL	https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer
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.

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the connection Idle Timeout

SECONDS

Proxy Config

Proxy

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

https://sandbox-quickbooks.api.intuit.com

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

Tls

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

https://appcenter.intuit.com/connect/oauth2

Access Token Url

String

The service provider’s accessToken endpoint URL

https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer

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.

Operations

Account Post2
Account Update
Attachable Post3
Batch Post
Bill Post3
Billpayment Post3
Class Post3
Creditmemo Post3
Customer Post3
Department Post3
Deposit Post3
Employee Post3
Estimate Post3
Invoice Post4
Item Post3
Journalentry Post3
Payment Post3
Paymentmethod Post3
Preferences Post
Purchase Post3
Purchaseorder Post3
Query Post32
Refundreceipt Post3
Salesreceipt Post4
Taxagency Post
Taxservice Taxcode Post
Term Post3
Timeactivity Post4
Transfer Post3
Upload Post
Vendor Post3
Vendorcredit Post3
Account Get
Attachable Get
Bill Get
Billpayment Get
Cdc Get
Class Get
Companyinfo By Companyid Get
Creditmemo Get
Customer Get
Department Get
Deposit Get
Employee Get
Estimate Get
Exchangerate Get
Invoice Get
Item ID Get
Journalentry Get
Payment174Get
Paymentmethod Get
Preferences Get
Purchase Get
Purchaseorder Get
Refundreceipt Get
Reports Account List Get
Reports Aged Payable Detail Get
Reports Aged Payables Get
Reports Aged Receivable Detail Get
Reports Aged Receivables Get
Reports Balance Sheet Get
Reports Cash Flow Get
Reports Class Sales Get
Reports Customer Balance Get
Reports Customer Balance Detail Get
Reports Customer Income Get
Reports Customer Sales Get
Reports Department Sales Get
Reports General Ledger Get
Reports Inventory Valuation Summary Get
Reports Item Sales Get
Reports Profit And Loss Get
Reports Profit And Loss Detail Get
Reports Transaction List Get
Reports Trial Balance Get
Reports Vendor Balance Get
Reports Vendor Balance Detail Get
Reports Vendor Expenses Get
Salesreceipt Get
Taxagency Get
Taxcode Get
Taxrate Get
Term Get
Transfer Get
Vendor Get
Vendorcredit Get
Unauthorize

Account Post2

<quick-books-online-v3api-collections-oauth2:create-account>

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
Accept	String	Accept		x
Content Type	String	Content Type		x
Account-CreateRequest	Any	the content to use	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit which qualifies the Response Timeout}
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.
Target Variable	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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

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

Accept

String

Accept

x

Content Type

String

Content Type

x

Account-CreateRequest

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Account Update

<quick-books-online-v3api-collections-oauth2:create-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
Accept	String	Accept		x
Content Type	String	Content Type		x
Account-CreateRequest	Any	the content to use	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit which qualifies the Response Timeout}
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.
Target Variable	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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

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

Accept

String

Accept

x

Content Type

String

Content Type

x

Account-CreateRequest

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Attachable Post3

<quick-books-online-v3api-collections-oauth2:create-attachable>

Create an attachable object Conent-Type:application/json Method - POST 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
Accept	String	Accept		x
Content Type	String	Content Type		x
Attachable-CreateRequest	Any	the content to use	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit which qualifies the Response Timeout}
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.
Target Variable	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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

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

Accept

String

Accept

x

Content Type

String

Content Type

x

Attachable-CreateRequest

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Batch Post

<quick-books-online-v3api-collections-oauth2:create-batch>

Multiple operations using batch query Content-Type:application/json Method - POST 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
Accept	String	Accept		x
Content Type	String	Content Type		x
BatchRequest	Any	the content to use	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit which qualifies the Response Timeout}
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.
Target Variable	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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

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

Accept

String

Accept

x

Content Type

String

Content Type

x

BatchRequest

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Bill Post3

<quick-books-online-v3api-collections-oauth2:create-bill>

Create a bill Content-Type:application/json Method - POST 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
Accept	String	Accept		x
Content Type	String	Content Type		x
Bill-CreateRequest	Any	the content to use	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit which qualifies the Response Timeout}
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.
Target Variable	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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

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

Accept

String

Accept

x

Content Type

String

Content Type

x

Bill-CreateRequest

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Billpayment Post3

<quick-books-online-v3api-collections-oauth2:create-billpayment>

Update a BillPayment Content-Type:application/json Method - POST 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
Accept	String	Accept		x
Content Type	String	Content Type		x
BillPayment-UpdateRequest	Any	the content to use	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit which qualifies the Response Timeout}
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.
Target Variable	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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

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

Accept

String

Accept

x

Content Type

String

Content Type

x

BillPayment-UpdateRequest

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Class Post3

<quick-books-online-v3api-collections-oauth2:create-class>

Create a Class object Method - POST 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
Accept	String	Accept		x
Content Type	String	Content Type		x
Class-CreateRequest	Any	the content to use	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit which qualifies the Response Timeout}
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.
Target Variable	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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

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

Accept

String

Accept

x

Content Type

String

Content Type

x

Class-CreateRequest

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Creditmemo Post3

<quick-books-online-v3api-collections-oauth2:create-creditmemo>

Update a credit memo Method : POST 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
Accept	String	Accept		x
Content Type	String	Content Type		x
CreditMemo-UpdateRequest	Any	the content to use	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit which qualifies the Response Timeout}
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.
Target Variable	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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

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

Accept

String

Accept

x

Content Type

String

Content Type

x

CreditMemo-UpdateRequest

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Customer Post3

<quick-books-online-v3api-collections-oauth2:create-customer>

Create a customer Method : POST 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
Accept	String	Accept		x
Content Type	String	Content Type		x
Customer-CreateRequest	Any	the content to use	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit which qualifies the Response Timeout}
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.
Target Variable	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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

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

Accept

String

Accept

x

Content Type

String

Content Type

x

Customer-CreateRequest

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Department Post3

<quick-books-online-v3api-collections-oauth2:create-department>

Create a department object Method : POST 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
Accept	String	Accept		x
Content Type	String	Content Type		x
Department-CreateRequest	Any	the content to use	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit which qualifies the Response Timeout}
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.
Target Variable	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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

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

Accept

String

Accept

x

Content Type

String

Content Type

x

Department-CreateRequest

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Deposit Post3

<quick-books-online-v3api-collections-oauth2:create-deposit>

Update a deposit object Method : POST 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
Accept	String	Accept		x
Content Type	String	Content Type		x
Deposit-UpdateRequest	Any	the content to use	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit which qualifies the Response Timeout}
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.
Target Variable	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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

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

Accept

String

Accept

x

Content Type

String

Content Type

x

Deposit-UpdateRequest

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Employee Post3

<quick-books-online-v3api-collections-oauth2:create-employee>

Delete an employee object Method : POST Delete via deactivation (active=false) 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
Accept	String	Accept		x
Content Type	String	Content Type		x
Employee-DeleteRequest	Any	the content to use	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit which qualifies the Response Timeout}
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.
Target Variable	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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

x

User Agent

String

User Agent

x

Accept

String

Accept

x

Content Type

String

Content Type

x

Employee-DeleteRequest

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Estimate Post3

<quick-books-online-v3api-collections-oauth2:create-estimate>

Update an Estimate object Method : POST 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
Accept	String	Accept		x
Content Type	String	Content Type		x
Estimate-UpdateRequest	Any	the content to use	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit which qualifies the Response Timeout}
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.
Target Variable	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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

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

Accept

String

Accept

x

Content Type

String

Content Type

x

Estimate-UpdateRequest

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Invoice Post4

<quick-books-online-v3api-collections-oauth2:create-invoice>

Create an invoice object Method : POST 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
Accept	String	Accept		x
Content Type	String	Content Type		x
Invoice-CreateRequest	Any	the content to use	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit which qualifies the Response Timeout}
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.
Target Variable	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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

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

Accept

String

Accept

x

Content Type

String

Content Type

x

Invoice-CreateRequest

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Item Post3

<quick-books-online-v3api-collections-oauth2:create-item>

Create an item object Method : POST 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
Accept	String	Accept		x
Content Type	String	Content Type		x
Item-CreateRequest	Any	the content to use	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit which qualifies the Response Timeout}
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.
Target Variable	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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

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

Accept

String

Accept

x

Content Type

String

Content Type

x

Item-CreateRequest

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Journalentry Post3

<quick-books-online-v3api-collections-oauth2:create-journalentry>

Create an journalentry object Method : POST 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
Accept	String	Accept		x
Content Type	String	Content Type		x
JournalEntry-CreateRequest	Any	the content to use	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit which qualifies the Response Timeout}
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.
Target Variable	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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

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

Accept

String

Accept

x

Content Type

String

Content Type

x

JournalEntry-CreateRequest

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Payment Post3

<quick-books-online-v3api-collections-oauth2:create-payment>

Create an payment object Method : POST 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
Accept	String	Accept		x
Content Type	String	Content Type		x
Payment-CreateRequest	Any	the content to use	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit which qualifies the Response Timeout}
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.
Target Variable	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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

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

Accept

String

Accept

x

Content Type

String

Content Type

x

Payment-CreateRequest

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Paymentmethod Post3

<quick-books-online-v3api-collections-oauth2:create-paymentmethod>

Update a payment method Method : POST 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
Accept	String	Accept		x
Content Type	String	Content Type		x
PaymentMethod-UpdateRequest	Any	the content to use	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit which qualifies the Response Timeout}
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.
Target Variable	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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

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

Accept

String

Accept

x

Content Type

String

Content Type

x

PaymentMethod-UpdateRequest

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Preferences Post

<quick-books-online-v3api-collections-oauth2:create-preferences>

Update the preference object endpoint Method : POST 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
Accept	String	Accept		x
Content Type	String	Content Type		x
Preference-UpdateRequest	Any	the content to use	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit which qualifies the Response Timeout}
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.
Target Variable	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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

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

Accept

String

Accept

x

Content Type

String

Content Type

x

Preference-UpdateRequest

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Purchase Post3

<quick-books-online-v3api-collections-oauth2:create-purchase>

Create a puchase object Method : POST 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
Accept	String	Accept		x
Content Type	String	Content Type		x
Purchase-UpdateRequest	Any	the content to use	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit which qualifies the Response Timeout}
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.
Target Variable	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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

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

Accept

String

Accept

x

Content Type

String

Content Type

x

Purchase-UpdateRequest

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Purchaseorder Post3

<quick-books-online-v3api-collections-oauth2:create-purchaseorder>

Create a puchase-order object Method : POST 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
Accept	String	Accept		x
Content Type	String	Content Type		x
PurchaseOrder-CreateRequest	Any	the content to use	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit which qualifies the Response Timeout}
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.
Target Variable	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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

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

Accept

String

Accept

x

Content Type

String

Content Type

x

PurchaseOrder-CreateRequest

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Query Post32

<quick-books-online-v3api-collections-oauth2:create-query>

Read all transfer objects using the 'Query' endpoint Method : POST This operation makes an HTTP POST 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
Accept	String	Accept		x
Content Type	String	Content Type		x
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit which qualifies the Response Timeout}
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.
Target Variable	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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

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

Accept

String

Accept

x

Content Type

String

Content Type

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Refundreceipt Post3

<quick-books-online-v3api-collections-oauth2:create-refundreceipt>

Update a refund-receipt object Method : POST 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
Accept	String	Accept		x
Content Type	String	Content Type		x
RefundReceipt-UpdateRequest	Any	the content to use	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit which qualifies the Response Timeout}
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.
Target Variable	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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

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

Accept

String

Accept

x

Content Type

String

Content Type

x

RefundReceipt-UpdateRequest

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Salesreceipt Post4

<quick-books-online-v3api-collections-oauth2:create-salesreceipt>

Create an salesreceipt object Method : POST 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
Accept	String	Accept		x
Content Type	String	Content Type		x
SalesReceipt-CreateRequest	Any	the content to use	#[payload]
Config Ref	ConfigurationProvider	The name of the configuration to use to execute this component		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit which qualifies the Response Timeout}
Streaming Type	Enumeration, one of: AUTO ALWAYS NEVER	Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.
Target Variable	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	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors

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

Accept

String

Accept

x

Content Type

String

Content Type

x

SalesReceipt-CreateRequest

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Taxagency Post

<quick-books-online-v3api-collections-oauth2:create-taxagency>

Create a tax-agency object Method : POST Sample response payload { "SalesReceipt": { "domain": "QBO", "status": "Deleted", "Id": "181" }, "time": "2016-09-02T02:17:24.353-07:00" } 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

Accept

String

Accept

x

Content Type

String

Content Type

x

TaxAgency-CreateRequest

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Taxservice Taxcode Post

<quick-books-online-v3api-collections-oauth2:create-taxservice-taxcode>

Use TaxService to create taxcode and corresponding taxrates Method : POST 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

Accept

String

Accept

x

Content Type

String

Content Type

x

TaxService-CreateRequest

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Term Post3

<quick-books-online-v3api-collections-oauth2:create-term>

Update a term object Method : POST Term object can’t be deleted parmanently. It can only be deactived by setting the 'Active' attribute to false. 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

Accept

String

Accept

x

Content Type

String

Content Type

x

Term-DeleteRequest

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Timeactivity Post4

<quick-books-online-v3api-collections-oauth2:create-timeactivity>

Create a term object Method : POST 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

Accept

String

Accept

x

Content Type

String

Content Type

x

TimeActivity-CreateRequest

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Transfer Post3

<quick-books-online-v3api-collections-oauth2:create-transfer>

Create a transfer object Method : POST 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

Accept

String

Accept

x

Content Type

String

Content Type

x

Transfer-CreateRequest

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Upload Post

<quick-books-online-v3api-collections-oauth2:create-upload>

Uploading and linking new attachments https://developer.intuit.com/docs/0100_quickbooks_online/0200_dev_guides/accounting/attachments#Uploading_and_linking_new_attachments If the attachment is not in the Attachment list already, it’s possible to upload it and link it to the object in one multipart operation. Operation: POST https://quickbooks.api.intuit.com/v3/company/companyID/upload Content type: multipart/form-data Request body The following sample code shows the multipart request body for uploading a file and its supporting Attachable metatdata object, with the result of it being both added to the Attachment list and added to the object. The Attachable object accompanying this request supplies metadata and object information to which the attachment is linked. Each part of the multipart request is separated by a boundary. In the sample below, the string --YOjcLaTlykb6OxfYJx4O07j1MweeMFem is used. You can use any random and unique string. The file to be uploaded and its Attachable object are paired together via the name parameter in the part header for each one. The name parameter for the file part is of the form file_content_nn, where nn is a unique index number among the set of files being uploaded. The name parameter for the Attachable object is of the form file_metadata_nn, where nn corresponds to the file index number used with the content . The file or files are stored in the Attachment list with the name specified by the filename parameter. If the data supplied with the Attachable object cannot be validated, an error is returned and the file is not uploaded. 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

User Agent

String

User Agent

x

Content Type

String

Content Type

x

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Vendor Post3

<quick-books-online-v3api-collections-oauth2:create-vendor>

Update a vendor object Method : POST 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

Accept

String

Accept

x

Content Type

String

Content Type

x

Vendor-UpdateRequest

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Vendorcredit Post3

<quick-books-online-v3api-collections-oauth2:create-vendorcredit>

Delete a vendorcredit object by Id Method : POST Sample response body { "VendorCredit": { "domain": "QBO", "status": "Deleted", "Id": "185" }, "time": "2016-09-02T03:14:13.909-07:00" } 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

Accept

String

Accept

x

Content Type

String

Content Type

x

VendorCredit-DeleteRequest

Any

the content to use

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Account Get

<quick-books-online-v3api-collections-oauth2:get-account>

Get the Account which has accountId as 1 This operation makes an HTTP GET request to the /account/ 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Attachable Get

<quick-books-online-v3api-collections-oauth2:get-attachable>

Retrieve an attachable object by Id Accept:application/json Method - GET This operation makes an HTTP GET request to the /attachable/ 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

Accept

String

Accept

x

Content Type

String

Content Type

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Bill Get

<quick-books-online-v3api-collections-oauth2:get-bill>

Retrieve a bill by Id Accept:application/json Method - GET This operation makes an HTTP GET request to the /bill/ 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Billpayment Get

<quick-books-online-v3api-collections-oauth2:get-billpayment>

Retrieve BillPayment by Id Method - GET This operation makes an HTTP GET request to the /billpayment/ 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Cdc Get

<quick-books-online-v3api-collections-oauth2:get-cdc>

Retrieve changed Bill and invoice objects since Aug10,2016 Method - GET 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

Accept

String

Accept

x

Content Type

String

Content Type

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Class Get

<quick-books-online-v3api-collections-oauth2:get-class>

Read a Class object by Id Method - GET This operation makes an HTTP GET request to the /class/ 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Companyinfo By Companyid Get

<quick-books-online-v3api-collections-oauth2:get-companyinfo>

Method : GET This operation makes an HTTP GET request to the /companyinfo/ endpoint

Parameters

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

x

Company Id

String

Company Id

x

Company Id

String

Company Id

x

minorversion

String

minorversion

x

User Agent

String

User Agent

x

Accept

String

Accept

x

Content Type

String

Content Type

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Creditmemo Get

<quick-books-online-v3api-collections-oauth2:get-creditmemo>

Read a credit memo by Id Method : GET This operation makes an HTTP GET request to the /creditmemo/ 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Customer Get

<quick-books-online-v3api-collections-oauth2:get-customer>

Read a customer entry by Id Method : GET This operation makes an HTTP GET request to the /customer/ 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Department Get

<quick-books-online-v3api-collections-oauth2:get-department>

Read a department object Method : GET This operation makes an HTTP GET request to the /department/ 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Deposit Get

<quick-books-online-v3api-collections-oauth2:get-deposit>

Read a deposit object by Id Method : POST This operation makes an HTTP GET request to the /deposit/ 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Employee Get

<quick-books-online-v3api-collections-oauth2:get-employee>

Retrieve an employee object by ID Method : GET This operation makes an HTTP GET request to the /employee/ endpoint

Parameters

Name

Type

Description

Default Value

Required

Configuration

String

The name of the configuration to use.

x

Emplyee Id

String

Emplyee Id

x

minorversion

String

minorversion

x

User Agent

String

User Agent

x

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Estimate Get

<quick-books-online-v3api-collections-oauth2:get-estimate>

Read an Estimate object by Id Method : POST This operation makes an HTTP GET request to the /estimate/ 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Exchangerate Get

<quick-books-online-v3api-collections-oauth2:get-exchangerate>

Get ExchangeRate Method : GET 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

Exchange Rate Id

String

Exchange Rate Id

x

sourcecurrencycode

String

sourcecurrencycode

x

asofdate

String

asofdate

x

minorversion

String

minorversion

x

User Agent

String

User Agent

x

Accept

String

Accept

x

Content Type

String

Content Type

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Invoice Get

<quick-books-online-v3api-collections-oauth2:get-invoice147>

Read an invoice object by Id Method : POST This operation makes an HTTP GET request to the /invoice/147 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Item ID Get

<quick-books-online-v3api-collections-oauth2:get-item>

Read an Item by Id Method : GET This operation makes an HTTP GET request to the /item/ 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Journalentry Get

<quick-books-online-v3api-collections-oauth2:get-journalentry>

Read an journalentry object by Id Method : POST This operation makes an HTTP GET request to the /journalentry/ 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Payment174Get

<quick-books-online-v3api-collections-oauth2:get-payment>

Read a payment object by Id Method : GET This operation makes an HTTP GET 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Paymentmethod Get

<quick-books-online-v3api-collections-oauth2:get-paymentmethod>

Read a payment method Method : GET This operation makes an HTTP GET request to the /paymentmethod/ 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Preferences Get

<quick-books-online-v3api-collections-oauth2:get-preferences>

Read the preference object Method : POST 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

Preferences Id

String

Preferences Id

x

minorversion

String

minorversion

x

User Agent

String

User Agent

x

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Purchase Get

<quick-books-online-v3api-collections-oauth2:get-purchase>

Read a puchase object by Id Method : POST This operation makes an HTTP GET request to the /purchase/ 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Purchaseorder Get

<quick-books-online-v3api-collections-oauth2:get-purchaseorder>

Read a puchase-order object Method : POST This operation makes an HTTP GET request to the /purchaseorder/ 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Refundreceipt Get

<quick-books-online-v3api-collections-oauth2:get-refundreceipt>

Read a refund-receipt object Method : GET This operation makes an HTTP GET request to the /refundreceipt/ 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Reports Account List Get

<quick-books-online-v3api-collections-oauth2:get-reports-account-list>

Report - Account list detail Method : GET The information below provides a reference on how to access the account list detail report from the QuickBooks Online Report Service. 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Reports Aged Payable Detail Get

<quick-books-online-v3api-collections-oauth2:get-reports-aged-payable-detail>

Report - AgedPayable aging detail Method : GET The information below provides a reference on how to access the AP Aging summary report from the QuickBooks Online Report Service. 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Reports Aged Payables Get

<quick-books-online-v3api-collections-oauth2:get-reports-aged-payables>

Report - AgedPayable aging summary Method : GET The information below provides a reference on how to access the AP Aging summary report from the QuickBooks Online Report Service. 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Reports Aged Receivable Detail Get

<quick-books-online-v3api-collections-oauth2:get-reports-aged-receivable-detail>

Report - AgedReceivableDetail aging detail Method : GET The information below provides a reference on how to access the AR Aging Detail report from the QuickBooks Online Report Service. 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Reports Aged Receivables Get

<quick-books-online-v3api-collections-oauth2:get-reports-aged-receivables>

Report - AgedReceivable aging summary Method : GET The information below provides a reference on how to access the AR Aging Summary report from the QuickBooks Online Report Service. 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Reports Balance Sheet Get

<quick-books-online-v3api-collections-oauth2:get-reports-balance-sheet>

Report - BalanceSheet Method : GET The information below provides a reference on how to query the Balance Sheet report from the QuickBooks Online Report Service. 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Reports Cash Flow Get

<quick-books-online-v3api-collections-oauth2:get-reports-cash-flow>

Report - CashFlow Method : GET The information below provides a reference on how to access the cash flow report from the QuickBooks Online Report Service. 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Reports Class Sales Get

<quick-books-online-v3api-collections-oauth2:get-reports-class-sales>

Report - CashSales Method : GET 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Reports Customer Balance Get

<quick-books-online-v3api-collections-oauth2:get-reports-customer-balance>

Report - CustomerBalance Method : GET 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Reports Customer Balance Detail Get

<quick-books-online-v3api-collections-oauth2:get-reports-customer-balance-detail>

Report - CustomerBalance Detail Method : GET The information below provides a reference on how to access the Customer Balance Detail report from the QuickBooks Online Report Service. 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

Customerbalance Id

String

Customerbalance Id

x

minorversion

String

minorversion

x

User Agent

String

User Agent

x

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Reports Customer Income Get

<quick-books-online-v3api-collections-oauth2:get-reports-customer-income>

Report - Customer Income Method : GET 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Reports Customer Sales Get

<quick-books-online-v3api-collections-oauth2:get-reports-customer-sales>

Report - Customer Sales Method : GET 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Reports Department Sales Get

<quick-books-online-v3api-collections-oauth2:get-reports-department-sales>

Report - Department Sales Method : GET 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

Department Sales Id

String

Department Sales Id

x

minorversion

String

minorversion

x

User Agent

String

User Agent

x

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Reports General Ledger Get

<quick-books-online-v3api-collections-oauth2:get-reports-general-ledger>

Report - General Ledger Method : GET Docs - https://developer.intuit.com/docs/api/accounting/general%20ledger 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Reports Inventory Valuation Summary Get

<quick-books-online-v3api-collections-oauth2:get-reports-inventory-valuation-summary>

Report - Inventory Valuation Summary Method : GET Docs - https://developer.intuit.com/docs/api/accounting/inventory%20valuation 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Reports Item Sales Get

<quick-books-online-v3api-collections-oauth2:get-reports-item-sales>

Report - Item Sales Method : GET Docs - https://developer.intuit.com/docs/api/accounting/sales%20by%20product 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

Item Id

String

Item Id

x

minorversion

String

minorversion

x

User Agent

String

User Agent

x

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Reports Profit And Loss Get

<quick-books-online-v3api-collections-oauth2:get-reports-profit-and-loss>

Report - Profit and Loss Method : GET Docs - https://developer.intuit.com/docs/api/accounting/profit%20and%20loss 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Reports Profit And Loss Detail Get

<quick-books-online-v3api-collections-oauth2:get-reports-profit-and-loss-detail>

Report - Profit and Loss Detail Method : GET Docs - https://developer.intuit.com/docs/api/accounting/profit%20and%20loss%20detail 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Reports Transaction List Get

<quick-books-online-v3api-collections-oauth2:get-reports-transaction-list>

Report - Trial List Method : GET Docs - https://developer.intuit.com/docs/api/accounting/transaction%20list 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Reports Trial Balance Get

<quick-books-online-v3api-collections-oauth2:get-reports-trial-balance>

Report - Trial Balance Method : GET Docs - https://developer.intuit.com/docs/api/accounting/trial%20balance 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Reports Vendor Balance Get

<quick-books-online-v3api-collections-oauth2:get-reports-vendor-balance>

Report - Vendor Balance Method : GET Docs - https://developer.intuit.com/docs/api/accounting/vendor%20balance 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Reports Vendor Balance Detail Get

<quick-books-online-v3api-collections-oauth2:get-reports-vendor-balance-detail>

Report - Vendor Balance Detail Method : GET Docs - https://developer.intuit.com/docs/api/accounting/vendor%20balance%20detail 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Reports Vendor Expenses Get

<quick-books-online-v3api-collections-oauth2:get-reports-vendor-expenses>

Report - Vendor Expense Method : GET Docs - https://developer.intuit.com/docs/api/accounting/expenses%20by%20vendor 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Salesreceipt Get

<quick-books-online-v3api-collections-oauth2:get-salesreceipt>

Create an salesreceipt object Method : POST This operation makes an HTTP GET request to the /salesreceipt/ 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Taxagency Get

<quick-books-online-v3api-collections-oauth2:get-taxagency>

Get a tax-agency object by ID Method : GET This operation makes an HTTP GET request to the /taxagency/ 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Taxcode Get

<quick-books-online-v3api-collections-oauth2:get-taxcode>

Read a taxcode by Id Method : POST This operation makes an HTTP GET request to the /taxcode/ 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

Accept

String

Accept

x

Content Type

String

Content Type

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Taxrate Get

<quick-books-online-v3api-collections-oauth2:get-taxrate>

Read a taxRate by Id Method : POST This operation makes an HTTP GET request to the /taxrate/ 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Term Get

<quick-books-online-v3api-collections-oauth2:get-term>

Read a term object by Id Method : Get This operation makes an HTTP GET request to the /term/ 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Transfer Get

<quick-books-online-v3api-collections-oauth2:get-transfer184>

Read a transfer object by Id Method : GET This operation makes an HTTP GET request to the /transfer/184 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Vendor Get

<quick-books-online-v3api-collections-oauth2:get-vendor>

Read a vendor object by Id Method : GET This operation makes an HTTP GET request to the /vendor/ 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

Accept

String

Accept

x

Content Type

String

Content Type

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Vendorcredit Get

<quick-books-online-v3api-collections-oauth2:get-vendorcredit>

Read a vendorcredit object by Id Method : GET Please change the VendorCredit it from 165 to a valid VendorCredit objectId which exists in your QBO account This operation makes an HTTP GET request to the /vendorcredit/ 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

Accept

String

Accept

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component

x

Streaming Strategy

Repeatable In Memory Stream
Repeatable File Store Stream
non-repeatable-stream

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

A time unit which qualifies the Response Timeout}

Streaming Type

Enumeration, one of:

AUTO
ALWAYS
NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

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

Reconnect
Reconnect Forever

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

Http Response Attributes

For Configurations

Config

Throws

QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:BAD_REQUEST
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CLIENT_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:CONNECTIVITY
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:INTERNAL_SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_ACCEPTABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:NOT_FOUND
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:RETRY_EXHAUSTED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVER_ERROR
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:SERVICE_UNAVAILABLE
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TIMEOUT
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:TOO_MANY_REQUESTS
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNAUTHORIZED
QUICK-BOOKS-ONLINE-V3API-COLLECTIONS-OAUTH2:UNSUPPORTED_MEDIA_TYPE

Unauthorize

<quick-books-online-v3api-collections-oauth2: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

For Configurations

Config

Types

Default Header

Field

Type

Description

Default Value

Required

Key

String

x

Value

String

x

Default Query Param

Field

Type

Description

Default Value

Required

Key

String

x

Value

String

x

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

Trust Store

Key Store

Key Store

Revocation Check

Standard Revocation Check
Custom Ocsp Responder
Crl File

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.

Crl File

Field

Type

Description

Default Value

Required

Path

String

The path to the CRL file.

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

Reconnect
Reconnect Forever

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:

NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

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:

BYTE
KB
MB
GB

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:

BYTE
KB
MB
GB

The unit in which maxInMemorySize is expressed