Zoho Books connector reference

Beta

This feature is in Beta. Workspace admins can control access to this feature from the Previews page. See Manage Databricks previews.

This page has reference information for the managed Zoho Books connector, including supported source tables and destination table schemas.

Required OAuth scopes

The connector authenticates with a Zoho Self Client. The Self Client must be authorized for the following read-only OAuth scopes in the Zoho Developer Console:

ZohoBooks.contacts.READ
ZohoBooks.settings.READ
ZohoBooks.estimates.READ
ZohoBooks.invoices.READ
ZohoBooks.customerpayments.READ
ZohoBooks.creditnotes.READ
ZohoBooks.projects.READ
ZohoBooks.expenses.READ
ZohoBooks.salesorders.READ
ZohoBooks.purchaseorders.READ
ZohoBooks.bills.READ
ZohoBooks.debitnotes.READ
ZohoBooks.vendorpayments.READ
ZohoBooks.banking.READ
ZohoBooks.accountants.READ

For more information, see the Zoho Books OAuth scopes reference.

Supported source tables

The Zoho Books connector supports the following source tables, all under the default source schema:

Source table	Primary key	Description	Sync mode	Cursor field
`users`	`user_id`	Users in your Zoho Books organization, including their roles and status.	Full refresh only
`banking`	`account_id`	Bank and credit card accounts configured in your Zoho Books organization.	Full refresh only
`organizations`	`organization_id`	Zoho Books organizations associated with your account, including currency and plan settings.	Full refresh only
`contacts`	`contact_id`	Customers and vendors in your Zoho Books organization.	Full refresh only
`items`	`item_id`	Products and services in your Zoho Books item catalog.	Full refresh only
`taxes`	`tax_id`	Tax rates and tax settings configured in your Zoho Books organization.	Full refresh only
`bills`	`bill_id`	Vendor bills that record amounts your organization owes.	Incremental	`last_modified_time`
`estimates`	`estimate_id`	Customer estimates and quotes that your organization issues.	Incremental	`last_modified_time`
`invoices`	`invoice_id`	Customer invoices that your organization issues.	Incremental	`last_modified_time`
`expenses`	`expense_id`	Business expenses recorded in your organization.	Incremental	`last_modified_time`
`creditnotes`	`creditnote_id`	Credit notes that your organization issues to customers.	Incremental	`last_modified_time`
`customer_payments`	`payment_id`	Payments that your organization receives from customers.	Incremental	`last_modified_time`
`purchase_orders`	`purchaseorder_id`	Purchase orders that your organization issues to vendors.	Incremental	`last_modified_time`
`sales_orders`	`salesorder_id`	Sales orders that your organization receives from customers.	Incremental	`last_modified_time`
`journals`	`journal_id`	Manual journal entries in your organization's books.	Incremental	`last_modified_time`
`transactions`	`transaction_id`	Bank and credit card transactions in your organization's accounts.	Incremental	`last_modified_time`

Destination table schemas

`users`

Field	Data type
`user_id`	`STRING`
`name`	`STRING`
`email`	`STRING`
`user_role`	`STRING`
`user_type`	`STRING`
`status`	`STRING`
`photo_url`	`STRING`
`mobile`	`STRING`
`role_id`	`STRING`
`invitation_type`	`STRING`
`is_current_user`	`BOOLEAN`
`is_employee`	`BOOLEAN`
`is_super_admin`	`BOOLEAN`
`is_customer_segmented`	`BOOLEAN`
`is_vendor_segmented`	`BOOLEAN`

`banking`

Field	Data type
`account_id`	`STRING`
`account_code`	`STRING`
`account_name`	`STRING`
`account_number`	`STRING`
`account_type`	`STRING`
`balance`	`DOUBLE`
`bank_balance`	`DOUBLE`
`bank_name`	`STRING`
`bcy_balance`	`DOUBLE`
`consent_info`	`STRUCT<consent_remaining_days: STRING, is_consent_expired: STRING>`
`currency_code`	`STRING`
`currency_id`	`STRING`
`feed_status`	`STRING`
`feeds_last_refresh_date`	`STRING`
`is_active`	`BOOLEAN`
`is_beta_feed`	`BOOLEAN`
`is_direct_paypal`	`BOOLEAN`
`is_paypal_account`	`BOOLEAN`
`is_primary_account`	`BOOLEAN`
`partner_bank_source`	`STRING`
`partner_bank_source_formatted`	`STRING`
`routing_number`	`STRING`
`statement_suggestion_count`	`DOUBLE`
`total_unprinted_checks`	`DOUBLE`
`uncategorized_transactions`	`DOUBLE`

`organizations`

Field	Data type
`organization_id`	`STRING`
`name`	`STRING`
`contact_name`	`STRING`
`email`	`STRING`
`phone`	`STRING`
`country`	`STRING`
`country_code`	`STRING`
`state`	`STRING`
`state_code`	`STRING`
`time_zone`	`STRING`
`time_zone_formatted`	`STRING`
`language_code`	`STRING`
`currency_id`	`STRING`
`currency_code`	`STRING`
`currency_symbol`	`STRING`
`currency_format`	`STRING`
`field_separator`	`STRING`
`fiscal_year_start_month`	`BIGINT`
`price_precision`	`BIGINT`
`sales_tax_type`	`STRING`
`mode`	`STRING`
`org_type`	`STRING`
`org_action`	`STRING`
`org_created_app_source`	`BIGINT`
`org_settings`	`BOOLEAN`
`org_joined_app_list`	`ARRAY<STRING>`
`AppList`	`ARRAY<STRING>`
`account_created_date`	`STRING`
`account_created_date_formatted`	`STRING`
`plan_name`	`STRING`
`plan_period`	`STRING`
`plan_type`	`BIGINT`
`source`	`BIGINT`
`custom_field_type`	`BIGINT`
`custom_fields`	`ARRAY<STRUCT<index: BIGINT, label: STRING, value: STRING>>`
`digital_signature_mode`	`STRING`
`is_dsign_required`	`BOOLEAN`
`is_user_dsign_mandatory`	`BOOLEAN`
`can_sign_invoice`	`BOOLEAN`
`can_change_timezone`	`BOOLEAN`
`can_show_document_tab`	`BOOLEAN`
`isOrgActive`	`BOOLEAN`
`isOrgNotSupported`	`BOOLEAN`
`is_org_active`	`BOOLEAN`
`is_default_org`	`BOOLEAN`
`is_solo_org`	`BOOLEAN`
`is_designated_zone`	`BOOLEAN`
`is_free_zone`	`BOOLEAN`
`is_export_with_payment_enabled`	`BOOLEAN`
`is_gst_india_version`	`BOOLEAN`
`is_hsn_or_sac_enabled`	`BOOLEAN`
`is_international_trade_enabled`	`BOOLEAN`
`is_invoice_pmt_tds_allowed`	`BOOLEAN`
`is_quick_setup_completed`	`BOOLEAN`
`is_registered_for_composite_scheme`	`BOOLEAN`
`is_registered_for_gst`	`BOOLEAN`
`is_registered_for_tax`	`BOOLEAN`
`is_sales_inclusive_tax_enabled`	`BOOLEAN`
`is_sales_reverse_charge_enabled`	`BOOLEAN`
`is_scan_preference_enabled`	`BOOLEAN`
`is_search360_enabled`	`STRING`
`is_sku_enabled`	`BOOLEAN`
`is_tax_registered`	`BOOLEAN`
`is_trial_expired`	`BOOLEAN`
`is_trial_period_extended`	`BOOLEAN`
`is_user_accountant`	`BOOLEAN`
`is_ziedition`	`BOOLEAN`
`is_zpayroll_grid`	`BOOLEAN`
`tax_group_enabled`	`BOOLEAN`
`user_status`	`BIGINT`
`user_status_formatted`	`STRING`
`version`	`STRING`
`version_formatted`	`STRING`
`zi_zb_client`	`BIGINT`
`zi_zb_edition`	`BIGINT`
`zoho_one_org`	`STRING`
`partners_domain`	`STRING`

`contacts`

Field	Data type
`contact_id`	`STRING`
`contact_name`	`STRING`
`company_name`	`STRING`
`contact_type`	`STRING`
`contact_type_formatted`	`STRING`
`customer_name`	`STRING`
`customer_sub_type`	`STRING`
`vendor_name`	`STRING`
`first_name`	`STRING`
`last_name`	`STRING`
`email`	`STRING`
`phone`	`STRING`
`mobile`	`STRING`
`website`	`STRING`
`facebook`	`STRING`
`twitter`	`STRING`
`status`	`STRING`
`portal_status`	`STRING`
`portal_status_formatted`	`STRING`
`source`	`STRING`
`language_code`	`STRING`
`language_code_formatted`	`STRING`
`currency_id`	`STRING`
`currency_code`	`STRING`
`payment_terms`	`BIGINT`
`payment_terms_label`	`STRING`
`ach_supported`	`BOOLEAN`
`has_attachment`	`BOOLEAN`
`is_linked_with_zohocrm`	`BOOLEAN`
`pan_no`	`STRING`
`outstanding_payable_amount`	`DOUBLE`
`outstanding_payable_amount_bcy`	`DOUBLE`
`outstanding_receivable_amount`	`DOUBLE`
`outstanding_receivable_amount_bcy`	`DOUBLE`
`unused_credits_payable_amount`	`DOUBLE`
`unused_credits_payable_amount_bcy`	`DOUBLE`
`unused_credits_receivable_amount`	`DOUBLE`
`unused_credits_receivable_amount_bcy`	`DOUBLE`
`created_time`	`STRING`
`created_time_formatted`	`STRING`
`last_modified_time`	`STRING`
`last_modified_time_formatted`	`STRING`

`items`

Field	Data type
`item_id`	`STRING`
`name`	`STRING`
`item_name`	`STRING`
`description`	`STRING`
`status`	`STRING`
`source`	`STRING`
`item_type`	`STRING`
`product_type`	`STRING`
`unit`	`STRING`
`rate`	`DOUBLE`
`purchase_rate`	`DOUBLE`
`purchase_description`	`STRING`
`sku`	`STRING`
`reorder_level`	`STRING`
`stock_on_hand`	`DOUBLE`
`available_stock`	`DOUBLE`
`actual_available_stock`	`DOUBLE`
`account_id`	`STRING`
`account_name`	`STRING`
`purchase_account_id`	`STRING`
`purchase_account_name`	`STRING`
`tax_id`	`STRING`
`tax_name`	`STRING`
`tax_percentage`	`DOUBLE`
`image_document_id`	`STRING`
`image_name`	`STRING`
`image_type`	`STRING`
`has_attachment`	`BOOLEAN`
`is_linked_with_zohocrm`	`BOOLEAN`
`zcrm_product_id`	`STRING`
`created_time`	`STRING`
`last_modified_time`	`STRING`

`taxes`

Field	Data type
`tax_id`	`STRING`
`tax_name`	`STRING`
`tax_percentage`	`DOUBLE`
`tax_type`	`STRING`
`tax_specific_type`	`STRING`
`tax_specification`	`STRING`
`tax_account_id`	`STRING`
`output_tax_account_name`	`STRING`
`status`	`STRING`
`is_default_tax`	`BOOLEAN`
`is_editable`	`BOOLEAN`
`is_inactive`	`BOOLEAN`
`start_date`	`STRING`
`end_date`	`STRING`
`diff_rate_reason`	`STRING`
`last_modified_time`	`STRING`

`bills`

Field	Data type
`bill_id`	`STRING`
`last_modified_time`	`STRING`
`bill_number`	`STRING`
`reference_number`	`STRING`
`vendor_id`	`STRING`
`vendor_name`	`STRING`
`status`	`STRING`
`current_sub_status`	`STRING`
`current_sub_status_id`	`STRING`
`entity_type`	`STRING`
`color_code`	`STRING`
`date`	`STRING`
`due_date`	`STRING`
`due_days`	`STRING`
`created_time`	`STRING`
`client_viewed_time`	`STRING`
`currency_code`	`STRING`
`currency_id`	`STRING`
`exchange_rate`	`DOUBLE`
`balance`	`DOUBLE`
`total`	`DOUBLE`
`tds_total`	`DOUBLE`
`unprocessed_payment_amount`	`DOUBLE`
`price_precision`	`BIGINT`
`attachment_name`	`STRING`
`has_attachment`	`BOOLEAN`
`is_viewed_by_client`	`BOOLEAN`
`is_bill_reconciliation_violated`	`BOOLEAN`
`is_tally_bill`	`BOOLEAN`
`is_uber_bill`	`BOOLEAN`

`estimates`

Field	Data type
`estimate_id`	`STRING`
`last_modified_time`	`STRING`
`estimate_number`	`STRING`
`reference_number`	`STRING`
`customer_id`	`STRING`
`customer_name`	`STRING`
`company_name`	`STRING`
`salesperson_id`	`STRING`
`salesperson_name`	`STRING`
`status`	`STRING`
`current_sub_status`	`STRING`
`current_sub_status_id`	`STRING`
`color_code`	`STRING`
`date`	`STRING`
`expiry_date`	`STRING`
`accepted_date`	`STRING`
`declined_date`	`STRING`
`client_viewed_time`	`STRING`
`created_time`	`STRING`
`currency_code`	`STRING`
`currency_id`	`STRING`
`total`	`DOUBLE`
`template_id`	`STRING`
`template_type`	`STRING`
`zcrm_potential_id`	`STRING`
`zcrm_potential_name`	`STRING`
`has_attachment`	`BOOLEAN`
`is_emailed`	`BOOLEAN`
`is_viewed_by_client`	`BOOLEAN`

`invoices`

Field	Data type
`invoice_id`	`STRING`
`last_modified_time`	`STRING`
`date`	`STRING`
`invoice_number`	`STRING`
`reference_number`	`STRING`
`status`	`STRING`
`current_sub_status`	`STRING`
`current_sub_status_id`	`STRING`
`type`	`STRING`
`transaction_type`	`STRING`
`customer_id`	`STRING`
`customer_name`	`STRING`
`company_name`	`STRING`
`email`	`STRING`
`phone`	`STRING`
`country`	`STRING`
`salesperson_id`	`STRING`
`salesperson_name`	`STRING`
`project_name`	`STRING`
`due_date`	`STRING`
`due_days`	`STRING`
`payment_expected_date`	`STRING`
`last_payment_date`	`STRING`
`last_reminder_sent_date`	`STRING`
`reminders_sent`	`BIGINT`
`created_time`	`STRING`
`created_by`	`STRING`
`updated_time`	`STRING`
`client_viewed_time`	`STRING`
`schedule_time`	`STRING`
`color_code`	`STRING`
`currency_code`	`STRING`
`currency_id`	`STRING`
`currency_symbol`	`STRING`
`exchange_rate`	`DOUBLE`
`adjustment`	`DOUBLE`
`balance`	`DOUBLE`
`total`	`DOUBLE`
`shipping_charge`	`DOUBLE`
`write_off_amount`	`DOUBLE`
`unprocessed_payment_amount`	`DOUBLE`
`no_of_copies`	`BIGINT`
`show_no_of_copies`	`BOOLEAN`
`ach_payment_initiated`	`BOOLEAN`
`has_attachment`	`BOOLEAN`
`is_emailed`	`BOOLEAN`
`is_pre_gst`	`BOOLEAN`
`is_viewed_by_client`	`BOOLEAN`
`invoice_url`	`STRING`
`documents`	`STRING`
`template_id`	`STRING`
`template_type`	`STRING`
`zcrm_potential_id`	`STRING`
`zcrm_potential_name`	`STRING`
`billing_address`	`STRUCT<address: STRING, attention: STRING, street2: STRING, city: STRING, state: STRING, zipcode: STRING, country: STRING, phone: STRING, fax: STRING>`
`shipping_address`	`STRUCT<address: STRING, attention: STRING, street2: STRING, city: STRING, state: STRING, zipcode: STRING, country: STRING, phone: STRING, fax: STRING>`

`expenses`

Field	Data type
`expense_id`	`STRING`
`last_modified_time`	`STRING`
`date`	`STRING`
`description`	`STRING`
`status`	`STRING`
`reference_number`	`STRING`
`expense_type`	`STRING`
`account_name`	`STRING`
`paid_through_account_name`	`STRING`
`vendor_id`	`STRING`
`vendor_name`	`STRING`
`customer_id`	`STRING`
`customer_name`	`STRING`
`user_name`	`STRING`
`report_id`	`STRING`
`report_name`	`STRING`
`report_number`	`STRING`
`expense_receipt_name`	`STRING`
`currency_code`	`STRING`
`currency_id`	`STRING`
`exchange_rate`	`DOUBLE`
`total`	`DOUBLE`
`total_without_tax`	`DOUBLE`
`bcy_total`	`DOUBLE`
`bcy_total_without_tax`	`DOUBLE`
`distance`	`DOUBLE`
`mileage_rate`	`DOUBLE`
`mileage_type`	`STRING`
`mileage_unit`	`STRING`
`start_reading`	`STRING`
`end_reading`	`STRING`
`custom_fields_list`	`STRING`
`has_attachment`	`BOOLEAN`
`is_billable`	`BOOLEAN`
`is_personal`	`BOOLEAN`
`created_time`	`STRING`

`creditnotes`

Field	Data type
`creditnote_id`	`STRING`
`last_modified_time`	`STRING`
`date`	`STRING`
`creditnote_number`	`STRING`
`reference_number`	`STRING`
`status`	`STRING`
`current_sub_status`	`STRING`
`current_sub_status_id`	`STRING`
`customer_id`	`STRING`
`customer_name`	`STRING`
`salesperson_id`	`STRING`
`salesperson_name`	`STRING`
`color_code`	`STRING`
`applied_invoices`	`STRING`
`client_viewed_time`	`STRING`
`created_time`	`STRING`
`currency_code`	`STRING`
`currency_id`	`STRING`
`exchange_rate`	`DOUBLE`
`balance`	`DOUBLE`
`total`	`DOUBLE`
`item_price`	`DOUBLE`
`item_quantity`	`DOUBLE`
`item_total`	`DOUBLE`
`item_total_price`	`DOUBLE`
`item_total_without_tax`	`DOUBLE`
`price_precision`	`BIGINT`
`template_id`	`STRING`
`template_type`	`STRING`
`has_attachment`	`BOOLEAN`
`is_emailed`	`BOOLEAN`
`is_viewed_by_client`	`BOOLEAN`

`customer_payments`

Field	Data type
`payment_id`	`STRING`
`last_modified_time`	`STRING`
`date`	`STRING`
`payment_number`	`STRING`
`payment_mode`	`STRING`
`payment_mode_formatted`	`STRING`
`payment_type`	`STRING`
`payment_status`	`STRING`
`payment_gateway`	`STRING`
`settlement_status`	`STRING`
`reference_number`	`STRING`
`gateway_transaction_id`	`STRING`
`invoice_numbers`	`STRING`
`last_four_digits`	`STRING`
`description`	`STRING`
`product_description`	`STRING`
`customer_id`	`STRING`
`customer_name`	`STRING`
`account_id`	`STRING`
`account_name`	`STRING`
`tax_account_id`	`STRING`
`tax_account_name`	`STRING`
`amount`	`DOUBLE`
`unused_amount`	`DOUBLE`
`tax_amount_withheld`	`DOUBLE`
`bcy_amount`	`DOUBLE`
`bcy_refunded_amount`	`DOUBLE`
`bcy_unused_amount`	`DOUBLE`
`documents`	`STRING`
`custom_fields_list`	`STRING`
`has_attachment`	`BOOLEAN`
`created_time`	`STRING`

`purchase_orders`

Field	Data type
`purchaseorder_id`	`STRING`
`last_modified_time`	`STRING`
`date`	`STRING`
`purchaseorder_number`	`STRING`
`reference_number`	`STRING`
`status`	`STRING`
`order_status`	`STRING`
`billed_status`	`STRING`
`current_sub_status`	`STRING`
`current_sub_status_id`	`STRING`
`vendor_id`	`STRING`
`vendor_name`	`STRING`
`company_name`	`STRING`
`color_code`	`STRING`
`delivery_date`	`STRING`
`delivery_days`	`STRING`
`due_by_days`	`STRING`
`due_in_days`	`STRING`
`client_viewed_time`	`STRING`
`created_time`	`STRING`
`currency_code`	`STRING`
`currency_id`	`STRING`
`total`	`DOUBLE`
`quantity_marked_as_received`	`DOUBLE`
`quantity_yet_to_receive`	`DOUBLE`
`price_precision`	`BIGINT`
`has_attachment`	`BOOLEAN`
`is_viewed_by_client`	`BOOLEAN`

`sales_orders`

Field	Data type
`salesorder_id`	`STRING`
`last_modified_time`	`STRING`
`date`	`STRING`
`salesorder_number`	`STRING`
`reference_number`	`STRING`
`status`	`STRING`
`order_status`	`STRING`
`invoiced_status`	`STRING`
`paid_status`	`STRING`
`order_fulfillment_type`	`STRING`
`current_sub_status`	`STRING`
`current_sub_status_id`	`STRING`
`customer_id`	`STRING`
`customer_name`	`STRING`
`company_name`	`STRING`
`email`	`STRING`
`salesperson_name`	`STRING`
`color_code`	`STRING`
`source`	`STRING`
`delivery_date`	`STRING`
`delivery_method`	`STRING`
`delivery_method_id`	`STRING`
`shipment_date`	`STRING`
`shipment_days`	`STRING`
`due_by_days`	`STRING`
`due_in_days`	`STRING`
`pickup_location_id`	`STRING`
`created_time`	`STRING`
`currency_code`	`STRING`
`currency_id`	`STRING`
`total`	`DOUBLE`
`bcy_total`	`DOUBLE`
`total_invoiced_amount`	`DOUBLE`
`quantity_invoiced`	`DOUBLE`
`custom_fields_list`	`STRING`
`zcrm_potential_id`	`STRING`
`zcrm_potential_name`	`STRING`
`has_attachment`	`BOOLEAN`
`is_emailed`	`BOOLEAN`

`journals`

Field	Data type
`journal_id`	`STRING`
`journal_date`	`STRING`
`entry_number`	`STRING`
`reference_number`	`STRING`
`journal_type`	`STRING`
`entity_type`	`STRING`
`status`	`STRING`
`notes`	`STRING`
`created_by_id`	`STRING`
`created_by_name`	`STRING`
`currency_id`	`STRING`
`total`	`DOUBLE`
`bcy_total`	`DOUBLE`

`transactions`

Field	Data type
`transaction_id`	`STRING`
`date`	`STRING`
`transaction_type`	`STRING`
`status`	`STRING`
`reconcile_status`	`STRING`
`reference_number`	`STRING`
`source`	`STRING`
`description`	`STRING`
`exclude_description`	`STRING`
`payee`	`STRING`
`customer_id`	`STRING`
`account_id`	`STRING`
`account_name`	`STRING`
`account_type`	`STRING`
`offset_account_code`	`STRING`
`offset_account_name`	`STRING`
`debit_or_credit`	`STRING`
`imported_transaction_id`	`STRING`
`payroll_tax_group_formatted`	`STRING`
`rule_id`	`STRING`
`rule_name`	`STRING`
`currency_code`	`STRING`
`currency_id`	`STRING`
`currency_symbol`	`STRING`
`amount`	`DOUBLE`
`running_balance`	`STRING`
`running_balance_formatted`	`STRING`
`price_precision`	`BIGINT`
`is_auto_categorized`	`BOOLEAN`
`is_excluded_by_system`	`BOOLEAN`
`is_offsetaccount_matched`	`BOOLEAN`
`is_paid_via_print_check`	`BOOLEAN`
`is_rule_exist`	`BOOLEAN`

Required OAuth scopes​

Supported source tables​

Destination table schemas​

users​

banking​

organizations​

contacts​

items​

taxes​

bills​

estimates​

invoices​

expenses​

creditnotes​

customer_payments​

purchase_orders​

sales_orders​

journals​

transactions​