airbyte 0.7.0-beta2, Mar 7 25

airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

airbyte.SourceQuickbooks

Explore with Pulumi AI

airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.airbyte.SourceQuickbooks;
import com.pulumi.airbyte.SourceQuickbooksArgs;
import com.pulumi.airbyte.inputs.SourceQuickbooksConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var mySourceQuickbooks = new SourceQuickbooks("mySourceQuickbooks", SourceQuickbooksArgs.builder()
            .configuration(SourceQuickbooksConfigurationArgs.builder()
                .access_token("...my_access_token...")
                .client_id("...my_client_id...")
                .client_secret("...my_client_secret...")
                .realm_id("...my_realm_id...")
                .refresh_token("...my_refresh_token...")
                .sandbox(true)
                .start_date("2021-03-20T00:00:00Z")
                .token_expiry_date("2022-09-21T20:04:23.212Z")
                .build())
            .definitionId("c133ff2e-7e08-4e71-ae0a-17bbfa4a6a9d")
            .secretId("...my_secret_id...")
            .workspaceId("2be97070-b111-42de-bb0f-eafb0a382554")
            .build());

    }
}

resources:
  mySourceQuickbooks:
    type: airbyte:SourceQuickbooks
    properties:
      configuration:
        access_token: '...my_access_token...'
        client_id: '...my_client_id...'
        client_secret: '...my_client_secret...'
        realm_id: '...my_realm_id...'
        refresh_token: '...my_refresh_token...'
        sandbox: true
        start_date: 2021-03-20T00:00:00Z
        token_expiry_date: 2022-09-21T20:04:23.212Z
      definitionId: c133ff2e-7e08-4e71-ae0a-17bbfa4a6a9d
      secretId: '...my_secret_id...'
      workspaceId: 2be97070-b111-42de-bb0f-eafb0a382554

Create SourceQuickbooks Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new SourceQuickbooks(name: string, args: SourceQuickbooksArgs, opts?: CustomResourceOptions);

@overload
def SourceQuickbooks(resource_name: str,
                     args: SourceQuickbooksArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def SourceQuickbooks(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     configuration: Optional[SourceQuickbooksConfigurationArgs] = None,
                     workspace_id: Optional[str] = None,
                     definition_id: Optional[str] = None,
                     name: Optional[str] = None,
                     secret_id: Optional[str] = None)

func NewSourceQuickbooks(ctx *Context, name string, args SourceQuickbooksArgs, opts ...ResourceOption) (*SourceQuickbooks, error)

public SourceQuickbooks(string name, SourceQuickbooksArgs args, CustomResourceOptions? opts = null)

public SourceQuickbooks(String name, SourceQuickbooksArgs args)
public SourceQuickbooks(String name, SourceQuickbooksArgs args, CustomResourceOptions options)

type: airbyte:SourceQuickbooks
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args SourceQuickbooksArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args SourceQuickbooksArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args SourceQuickbooksArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SourceQuickbooksArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SourceQuickbooksArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var sourceQuickbooksResource = new Airbyte.SourceQuickbooks("sourceQuickbooksResource", new()
{
    Configuration = new Airbyte.Inputs.SourceQuickbooksConfigurationArgs
    {
        AccessToken = "string",
        ClientId = "string",
        ClientSecret = "string",
        RealmId = "string",
        RefreshToken = "string",
        StartDate = "string",
        TokenExpiryDate = "string",
        Sandbox = false,
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

example, err := airbyte.NewSourceQuickbooks(ctx, "sourceQuickbooksResource", &airbyte.SourceQuickbooksArgs{
Configuration: &.SourceQuickbooksConfigurationArgs{
AccessToken: pulumi.String("string"),
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
RealmId: pulumi.String("string"),
RefreshToken: pulumi.String("string"),
StartDate: pulumi.String("string"),
TokenExpiryDate: pulumi.String("string"),
Sandbox: pulumi.Bool(false),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

var sourceQuickbooksResource = new SourceQuickbooks("sourceQuickbooksResource", SourceQuickbooksArgs.builder()
    .configuration(SourceQuickbooksConfigurationArgs.builder()
        .accessToken("string")
        .clientId("string")
        .clientSecret("string")
        .realmId("string")
        .refreshToken("string")
        .startDate("string")
        .tokenExpiryDate("string")
        .sandbox(false)
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

source_quickbooks_resource = airbyte.SourceQuickbooks("sourceQuickbooksResource",
    configuration={
        "access_token": "string",
        "client_id": "string",
        "client_secret": "string",
        "realm_id": "string",
        "refresh_token": "string",
        "start_date": "string",
        "token_expiry_date": "string",
        "sandbox": False,
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

const sourceQuickbooksResource = new airbyte.SourceQuickbooks("sourceQuickbooksResource", {
    configuration: {
        accessToken: "string",
        clientId: "string",
        clientSecret: "string",
        realmId: "string",
        refreshToken: "string",
        startDate: "string",
        tokenExpiryDate: "string",
        sandbox: false,
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

type: airbyte:SourceQuickbooks
properties:
    configuration:
        accessToken: string
        clientId: string
        clientSecret: string
        realmId: string
        refreshToken: string
        sandbox: false
        startDate: string
        tokenExpiryDate: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

SourceQuickbooks Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SourceQuickbooks resource accepts the following input properties:

Configuration SourceQuickbooksConfiguration
WorkspaceId string
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

Configuration SourceQuickbooksConfigurationArgs
WorkspaceId string
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration SourceQuickbooksConfiguration
workspaceId String
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration SourceQuickbooksConfiguration
workspaceId string
definitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name string: Name of the source e.g. dev-mysql-instance.
secretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration SourceQuickbooksConfigurationArgs
workspace_id str
definition_id str: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name str: Name of the source e.g. dev-mysql-instance.
secret_id str: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

configuration Property Map
workspaceId String
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

Outputs

All input properties are implicitly available as output properties. Additionally, the SourceQuickbooks resource produces the following output properties:

CreatedAt double
Id string: The provider-assigned unique ID for this managed resource.
SourceId string
SourceType string

CreatedAt float64
Id string: The provider-assigned unique ID for this managed resource.
SourceId string
SourceType string

createdAt Double
id String: The provider-assigned unique ID for this managed resource.
sourceId String
sourceType String

createdAt number
id string: The provider-assigned unique ID for this managed resource.
sourceId string
sourceType string

created_at float
id str: The provider-assigned unique ID for this managed resource.
source_id str
source_type str

createdAt Number
id String: The provider-assigned unique ID for this managed resource.
sourceId String
sourceType String

Look up Existing SourceQuickbooks Resource

Get an existing SourceQuickbooks resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: SourceQuickbooksState, opts?: CustomResourceOptions): SourceQuickbooks

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceQuickbooksConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        name: Optional[str] = None,
        secret_id: Optional[str] = None,
        source_id: Optional[str] = None,
        source_type: Optional[str] = None,
        workspace_id: Optional[str] = None) -> SourceQuickbooks

func GetSourceQuickbooks(ctx *Context, name string, id IDInput, state *SourceQuickbooksState, opts ...ResourceOption) (*SourceQuickbooks, error)

public static SourceQuickbooks Get(string name, Input<string> id, SourceQuickbooksState? state, CustomResourceOptions? opts = null)

public static SourceQuickbooks get(String name, Output<String> id, SourceQuickbooksState state, CustomResourceOptions options)

resources:  _:    type: airbyte:SourceQuickbooks    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Configuration SourceQuickbooksConfiguration
CreatedAt double
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string

Configuration SourceQuickbooksConfigurationArgs
CreatedAt float64
DefinitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string: Name of the source e.g. dev-mysql-instance.
SecretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string

configuration SourceQuickbooksConfiguration
createdAt Double
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String

configuration SourceQuickbooksConfiguration
createdAt number
definitionId string: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name string: Name of the source e.g. dev-mysql-instance.
secretId string: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId string
sourceType string
workspaceId string

configuration SourceQuickbooksConfigurationArgs
created_at float
definition_id str: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name str: Name of the source e.g. dev-mysql-instance.
secret_id str: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
source_id str
source_type str
workspace_id str

configuration Property Map
createdAt Number
definitionId String: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String: Name of the source e.g. dev-mysql-instance.
secretId String: Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String

Supporting Types

SourceQuickbooksConfiguration, SourceQuickbooksConfigurationArgs

AccessToken string: Access token for making authenticated requests.
ClientId string: Identifies which app is making the request. Obtain this value from the Keys tab on the app profile via My Apps on the developer site. There are two versions of this key: development and production.
ClientSecret string: Obtain this value from the Keys tab on the app profile via My Apps on the developer site. There are two versions of this key: development and production.
RealmId string: Labeled Company ID. The Make API Calls panel is populated with the realm id and the current access token.
RefreshToken string: A token used when refreshing the access token.
StartDate string: The default value to use if no bookmark exists for an endpoint (rfc3339 date string). E.g, 2021-03-20T00:00:00Z. Any data before this date will not be replicated.
TokenExpiryDate string: The date-time when the access token should be refreshed.
Sandbox bool: Determines whether to use the sandbox or production environment. Default: false

AccessToken string: Access token for making authenticated requests.
ClientId string: Identifies which app is making the request. Obtain this value from the Keys tab on the app profile via My Apps on the developer site. There are two versions of this key: development and production.
ClientSecret string: Obtain this value from the Keys tab on the app profile via My Apps on the developer site. There are two versions of this key: development and production.
RealmId string: Labeled Company ID. The Make API Calls panel is populated with the realm id and the current access token.
RefreshToken string: A token used when refreshing the access token.
StartDate string: The default value to use if no bookmark exists for an endpoint (rfc3339 date string). E.g, 2021-03-20T00:00:00Z. Any data before this date will not be replicated.
TokenExpiryDate string: The date-time when the access token should be refreshed.
Sandbox bool: Determines whether to use the sandbox or production environment. Default: false

accessToken String: Access token for making authenticated requests.
clientId String: Identifies which app is making the request. Obtain this value from the Keys tab on the app profile via My Apps on the developer site. There are two versions of this key: development and production.
clientSecret String: Obtain this value from the Keys tab on the app profile via My Apps on the developer site. There are two versions of this key: development and production.
realmId String: Labeled Company ID. The Make API Calls panel is populated with the realm id and the current access token.
refreshToken String: A token used when refreshing the access token.
startDate String: The default value to use if no bookmark exists for an endpoint (rfc3339 date string). E.g, 2021-03-20T00:00:00Z. Any data before this date will not be replicated.
tokenExpiryDate String: The date-time when the access token should be refreshed.
sandbox Boolean: Determines whether to use the sandbox or production environment. Default: false

accessToken string: Access token for making authenticated requests.
clientId string: Identifies which app is making the request. Obtain this value from the Keys tab on the app profile via My Apps on the developer site. There are two versions of this key: development and production.
clientSecret string: Obtain this value from the Keys tab on the app profile via My Apps on the developer site. There are two versions of this key: development and production.
realmId string: Labeled Company ID. The Make API Calls panel is populated with the realm id and the current access token.
refreshToken string: A token used when refreshing the access token.
startDate string: The default value to use if no bookmark exists for an endpoint (rfc3339 date string). E.g, 2021-03-20T00:00:00Z. Any data before this date will not be replicated.
tokenExpiryDate string: The date-time when the access token should be refreshed.
sandbox boolean: Determines whether to use the sandbox or production environment. Default: false

access_token str: Access token for making authenticated requests.
client_id str: Identifies which app is making the request. Obtain this value from the Keys tab on the app profile via My Apps on the developer site. There are two versions of this key: development and production.
client_secret str: Obtain this value from the Keys tab on the app profile via My Apps on the developer site. There are two versions of this key: development and production.
realm_id str: Labeled Company ID. The Make API Calls panel is populated with the realm id and the current access token.
refresh_token str: A token used when refreshing the access token.
start_date str: The default value to use if no bookmark exists for an endpoint (rfc3339 date string). E.g, 2021-03-20T00:00:00Z. Any data before this date will not be replicated.
token_expiry_date str: The date-time when the access token should be refreshed.
sandbox bool: Determines whether to use the sandbox or production environment. Default: false

accessToken String: Access token for making authenticated requests.
clientId String: Identifies which app is making the request. Obtain this value from the Keys tab on the app profile via My Apps on the developer site. There are two versions of this key: development and production.
clientSecret String: Obtain this value from the Keys tab on the app profile via My Apps on the developer site. There are two versions of this key: development and production.
realmId String: Labeled Company ID. The Make API Calls panel is populated with the realm id and the current access token.
refreshToken String: A token used when refreshing the access token.
startDate String: The default value to use if no bookmark exists for an endpoint (rfc3339 date string). E.g, 2021-03-20T00:00:00Z. Any data before this date will not be replicated.
tokenExpiryDate String: The date-time when the access token should be refreshed.
sandbox Boolean: Determines whether to use the sandbox or production environment. Default: false

Import

$ pulumi import airbyte:index/sourceQuickbooks:SourceQuickbooks my_airbyte_source_quickbooks ""

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: airbyte airbytehq/terraform-provider-airbyte
License
Notes: This Pulumi package is based on the airbyte Terraform Provider.

airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

airbytehq/terraform-provider-airbyte

airbyte.SourceQuickbooks

On this page

On this page

Example Usage

Create SourceQuickbooks Resource

Constructor syntax

Parameters

Constructor example

SourceQuickbooks Resource Properties

Inputs

Outputs

Look up Existing SourceQuickbooks Resource

Supporting Types

SourceQuickbooksConfiguration, SourceQuickbooksConfigurationArgs

Import

Package Details

On this page

On this page