Share via


QuickBooksLinkedService Class

QuickBooks server linked service. This linked service has supported version property. The Version 1.0 is scheduled for deprecation while your pipeline will continue to run after EOL but without any bug fix or new features.

All required parameters must be populated in order to send to server.

Constructor

QuickBooksLinkedService(*, additional_properties: dict[str, collections.abc.MutableMapping[str, Any]] | None = None, version: str | None = None, connect_via: _models.IntegrationRuntimeReference | None = None, description: str | None = None, parameters: dict[str, '_models.ParameterSpecification'] | None = None, annotations: list[collections.abc.MutableMapping[str, Any]] | None = None, connection_properties: MutableMapping[str, Any] | None = None, endpoint: MutableMapping[str, Any] | None = None, company_id: MutableMapping[str, Any] | None = None, consumer_key: MutableMapping[str, Any] | None = None, consumer_secret: _models.SecretBase | None = None, access_token: _models.SecretBase | None = None, access_token_secret: _models.SecretBase | None = None, refresh_token: _models.SecretBase | None = None, use_encrypted_endpoints: MutableMapping[str, Any] | None = None, encrypted_credential: str | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
additional_properties
dict[str, <xref:JSON>]

Unmatched properties from the message are deserialized to this collection.

Default value: None
version
str

Version of the linked service.

Default value: None
connect_via

The integration runtime reference.

Default value: None
description
str

Linked service description.

Default value: None
parameters

Parameters for linked service.

Default value: None
annotations
list[<xref:JSON>]

List of tags that can be used for describing the linked service.

Default value: None
connection_properties
<xref:JSON>

Properties used to connect to QuickBooks. It is mutually exclusive with any other properties in the linked service. Type: object.

Default value: None
endpoint
<xref:JSON>

The endpoint of the QuickBooks server. (i.e. quickbooks.api.intuit.com).

Default value: None
company_id
<xref:JSON>

The company ID of the QuickBooks company to authorize.

Default value: None
consumer_key
<xref:JSON>

The consumer key for OAuth 2.0 authentication.

Default value: None
consumer_secret

The consumer secret for OAuth 2.0 authentication.

Default value: None
access_token

The access token for OAuth 2.0 authentication.

Default value: None
access_token_secret

The access token secret is deprecated for OAuth 1.0 authentication. Only used for version 1.0.

Default value: None
refresh_token

The refresh token for OAuth 2.0 authentication.

Default value: None
use_encrypted_endpoints
<xref:JSON>

Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Only used for version 1.0.

Default value: None
encrypted_credential
str

The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.

Default value: None

Variables

Name Description
additional_properties
dict[str, <xref:JSON>]

Unmatched properties from the message are deserialized to this collection.

type
str

Type of linked service. Required.

version
str

Version of the linked service.

connect_via

The integration runtime reference.

description
str

Linked service description.

parameters

Parameters for linked service.

annotations
list[<xref:JSON>]

List of tags that can be used for describing the linked service.

connection_properties
<xref:JSON>

Properties used to connect to QuickBooks. It is mutually exclusive with any other properties in the linked service. Type: object.

endpoint
<xref:JSON>

The endpoint of the QuickBooks server. (i.e. quickbooks.api.intuit.com).

company_id
<xref:JSON>

The company ID of the QuickBooks company to authorize.

consumer_key
<xref:JSON>

The consumer key for OAuth 2.0 authentication.

consumer_secret

The consumer secret for OAuth 2.0 authentication.

access_token

The access token for OAuth 2.0 authentication.

access_token_secret

The access token secret is deprecated for OAuth 1.0 authentication. Only used for version 1.0.

refresh_token

The refresh token for OAuth 2.0 authentication.

use_encrypted_endpoints
<xref:JSON>

Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Only used for version 1.0.

encrypted_credential
str

The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.