1. Packages
  2. Airbyte Provider
  3. API Docs
  4. SourceZohoBooks
airbyte 0.9.0 published on Wednesday, Apr 9, 2025 by airbytehq

airbyte.SourceZohoBooks

Explore with Pulumi AI

SourceZohoBooks Resource

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.SourceZohoBooks;
import com.pulumi.airbyte.SourceZohoBooksArgs;
import com.pulumi.airbyte.inputs.SourceZohoBooksConfigurationArgs;
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 mySourceZohobooks = new SourceZohoBooks("mySourceZohobooks", SourceZohoBooksArgs.builder()
            .configuration(SourceZohoBooksConfigurationArgs.builder()
                .client_id("...my_client_id...")
                .client_secret("...my_client_secret...")
                .refresh_token("...my_refresh_token...")
                .region("in")
                .start_date("2021-03-22T04:14:38.625Z")
                .build())
            .definitionId("6f8e92e2-1bc5-4376-a6c5-27667675dfca")
            .secretId("...my_secret_id...")
            .workspaceId("13569afd-697a-4e40-9f7d-a6c0448a449b")
            .build());

    }
}
Copy
resources:
  mySourceZohobooks:
    type: airbyte:SourceZohoBooks
    properties:
      configuration:
        client_id: '...my_client_id...'
        client_secret: '...my_client_secret...'
        refresh_token: '...my_refresh_token...'
        region: in
        start_date: 2021-03-22T04:14:38.625Z
      definitionId: 6f8e92e2-1bc5-4376-a6c5-27667675dfca
      secretId: '...my_secret_id...'
      workspaceId: 13569afd-697a-4e40-9f7d-a6c0448a449b
Copy

Create SourceZohoBooks Resource

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

Constructor syntax

new SourceZohoBooks(name: string, args: SourceZohoBooksArgs, opts?: CustomResourceOptions);
@overload
def SourceZohoBooks(resource_name: str,
                    args: SourceZohoBooksArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def SourceZohoBooks(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    configuration: Optional[SourceZohoBooksConfigurationArgs] = None,
                    workspace_id: Optional[str] = None,
                    definition_id: Optional[str] = None,
                    name: Optional[str] = None,
                    secret_id: Optional[str] = None)
func NewSourceZohoBooks(ctx *Context, name string, args SourceZohoBooksArgs, opts ...ResourceOption) (*SourceZohoBooks, error)
public SourceZohoBooks(string name, SourceZohoBooksArgs args, CustomResourceOptions? opts = null)
public SourceZohoBooks(String name, SourceZohoBooksArgs args)
public SourceZohoBooks(String name, SourceZohoBooksArgs args, CustomResourceOptions options)
type: airbyte:SourceZohoBooks
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SourceZohoBooksArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SourceZohoBooksArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SourceZohoBooksArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SourceZohoBooksArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SourceZohoBooksArgs
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 sourceZohoBooksResource = new Airbyte.SourceZohoBooks("sourceZohoBooksResource", new()
{
    Configuration = new Airbyte.Inputs.SourceZohoBooksConfigurationArgs
    {
        ClientId = "string",
        ClientSecret = "string",
        RefreshToken = "string",
        Region = "string",
        StartDate = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});
Copy
example, err := airbyte.NewSourceZohoBooks(ctx, "sourceZohoBooksResource", &airbyte.SourceZohoBooksArgs{
Configuration: &.SourceZohoBooksConfigurationArgs{
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
RefreshToken: pulumi.String("string"),
Region: pulumi.String("string"),
StartDate: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})
Copy
var sourceZohoBooksResource = new SourceZohoBooks("sourceZohoBooksResource", SourceZohoBooksArgs.builder()
    .configuration(SourceZohoBooksConfigurationArgs.builder()
        .clientId("string")
        .clientSecret("string")
        .refreshToken("string")
        .region("string")
        .startDate("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());
Copy
source_zoho_books_resource = airbyte.SourceZohoBooks("sourceZohoBooksResource",
    configuration={
        "client_id": "string",
        "client_secret": "string",
        "refresh_token": "string",
        "region": "string",
        "start_date": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")
Copy
const sourceZohoBooksResource = new airbyte.SourceZohoBooks("sourceZohoBooksResource", {
    configuration: {
        clientId: "string",
        clientSecret: "string",
        refreshToken: "string",
        region: "string",
        startDate: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});
Copy
type: airbyte:SourceZohoBooks
properties:
    configuration:
        clientId: string
        clientSecret: string
        refreshToken: string
        region: string
        startDate: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string
Copy

SourceZohoBooks 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 SourceZohoBooks resource accepts the following input properties:

Configuration This property is required. SourceZohoBooksConfiguration
WorkspaceId This property is required. 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 This property is required. SourceZohoBooksConfigurationArgs
WorkspaceId This property is required. 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 This property is required. SourceZohoBooksConfiguration
workspaceId This property is required. 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 This property is required. SourceZohoBooksConfiguration
workspaceId This property is required. 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 This property is required. SourceZohoBooksConfigurationArgs
workspace_id This property is required. 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 This property is required. Property Map
workspaceId This property is required. 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 SourceZohoBooks resource produces the following output properties:

CreatedAt double
Id string
The provider-assigned unique ID for this managed resource.
ResourceAllocation SourceZohoBooksResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SourceId string
SourceType string
CreatedAt float64
Id string
The provider-assigned unique ID for this managed resource.
ResourceAllocation SourceZohoBooksResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SourceId string
SourceType string
createdAt Double
id String
The provider-assigned unique ID for this managed resource.
resourceAllocation SourceZohoBooksResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
sourceId String
sourceType String
createdAt number
id string
The provider-assigned unique ID for this managed resource.
resourceAllocation SourceZohoBooksResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
sourceId string
sourceType string
created_at float
id str
The provider-assigned unique ID for this managed resource.
resource_allocation SourceZohoBooksResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
source_id str
source_type str
createdAt Number
id String
The provider-assigned unique ID for this managed resource.
resourceAllocation Property Map
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
sourceId String
sourceType String

Look up Existing SourceZohoBooks Resource

Get an existing SourceZohoBooks 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?: SourceZohoBooksState, opts?: CustomResourceOptions): SourceZohoBooks
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceZohoBooksConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        name: Optional[str] = None,
        resource_allocation: Optional[SourceZohoBooksResourceAllocationArgs] = None,
        secret_id: Optional[str] = None,
        source_id: Optional[str] = None,
        source_type: Optional[str] = None,
        workspace_id: Optional[str] = None) -> SourceZohoBooks
func GetSourceZohoBooks(ctx *Context, name string, id IDInput, state *SourceZohoBooksState, opts ...ResourceOption) (*SourceZohoBooks, error)
public static SourceZohoBooks Get(string name, Input<string> id, SourceZohoBooksState? state, CustomResourceOptions? opts = null)
public static SourceZohoBooks get(String name, Output<String> id, SourceZohoBooksState state, CustomResourceOptions options)
resources:  _:    type: airbyte:SourceZohoBooks    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 SourceZohoBooksConfiguration
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.
ResourceAllocation SourceZohoBooksResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SecretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string
Configuration SourceZohoBooksConfigurationArgs
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.
ResourceAllocation SourceZohoBooksResourceAllocationArgs
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SecretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string
configuration SourceZohoBooksConfiguration
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.
resourceAllocation SourceZohoBooksResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
secretId String
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String
configuration SourceZohoBooksConfiguration
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.
resourceAllocation SourceZohoBooksResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
secretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId string
sourceType string
workspaceId string
configuration SourceZohoBooksConfigurationArgs
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.
resource_allocation SourceZohoBooksResourceAllocationArgs
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
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.
resourceAllocation Property Map
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
secretId String
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String

Supporting Types

SourceZohoBooksConfiguration
, SourceZohoBooksConfigurationArgs

ClientId This property is required. string
ClientSecret This property is required. string
RefreshToken This property is required. string
Region This property is required. string
The region code for the Zoho Books API, such as 'com', 'eu', 'in', etc. must be one of ["com", "eu", "in", "com.cn", "com.au", "jp", "sa", "ca"]
StartDate This property is required. string
ClientId This property is required. string
ClientSecret This property is required. string
RefreshToken This property is required. string
Region This property is required. string
The region code for the Zoho Books API, such as 'com', 'eu', 'in', etc. must be one of ["com", "eu", "in", "com.cn", "com.au", "jp", "sa", "ca"]
StartDate This property is required. string
clientId This property is required. String
clientSecret This property is required. String
refreshToken This property is required. String
region This property is required. String
The region code for the Zoho Books API, such as 'com', 'eu', 'in', etc. must be one of ["com", "eu", "in", "com.cn", "com.au", "jp", "sa", "ca"]
startDate This property is required. String
clientId This property is required. string
clientSecret This property is required. string
refreshToken This property is required. string
region This property is required. string
The region code for the Zoho Books API, such as 'com', 'eu', 'in', etc. must be one of ["com", "eu", "in", "com.cn", "com.au", "jp", "sa", "ca"]
startDate This property is required. string
client_id This property is required. str
client_secret This property is required. str
refresh_token This property is required. str
region This property is required. str
The region code for the Zoho Books API, such as 'com', 'eu', 'in', etc. must be one of ["com", "eu", "in", "com.cn", "com.au", "jp", "sa", "ca"]
start_date This property is required. str
clientId This property is required. String
clientSecret This property is required. String
refreshToken This property is required. String
region This property is required. String
The region code for the Zoho Books API, such as 'com', 'eu', 'in', etc. must be one of ["com", "eu", "in", "com.cn", "com.au", "jp", "sa", "ca"]
startDate This property is required. String

SourceZohoBooksResourceAllocation
, SourceZohoBooksResourceAllocationArgs

Default SourceZohoBooksResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
JobSpecifics List<SourceZohoBooksResourceAllocationJobSpecific>
Default SourceZohoBooksResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
JobSpecifics []SourceZohoBooksResourceAllocationJobSpecific
default_ SourceZohoBooksResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics List<SourceZohoBooksResourceAllocationJobSpecific>
default SourceZohoBooksResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics SourceZohoBooksResourceAllocationJobSpecific[]
default SourceZohoBooksResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
job_specifics Sequence[SourceZohoBooksResourceAllocationJobSpecific]
default Property Map
optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics List<Property Map>

SourceZohoBooksResourceAllocationDefault
, SourceZohoBooksResourceAllocationDefaultArgs

SourceZohoBooksResourceAllocationJobSpecific
, SourceZohoBooksResourceAllocationJobSpecificArgs

JobType string
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
ResourceRequirements SourceZohoBooksResourceAllocationJobSpecificResourceRequirements
optional resource requirements to run workers (blank for unbounded allocations)
JobType string
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
ResourceRequirements SourceZohoBooksResourceAllocationJobSpecificResourceRequirements
optional resource requirements to run workers (blank for unbounded allocations)
jobType String
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resourceRequirements SourceZohoBooksResourceAllocationJobSpecificResourceRequirements
optional resource requirements to run workers (blank for unbounded allocations)
jobType string
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resourceRequirements SourceZohoBooksResourceAllocationJobSpecificResourceRequirements
optional resource requirements to run workers (blank for unbounded allocations)
job_type str
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resource_requirements SourceZohoBooksResourceAllocationJobSpecificResourceRequirements
optional resource requirements to run workers (blank for unbounded allocations)
jobType String
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resourceRequirements Property Map
optional resource requirements to run workers (blank for unbounded allocations)

SourceZohoBooksResourceAllocationJobSpecificResourceRequirements
, SourceZohoBooksResourceAllocationJobSpecificResourceRequirementsArgs

Import

$ pulumi import airbyte:index/sourceZohoBooks:SourceZohoBooks my_airbyte_source_zoho_books ""
Copy

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.