Zoho Books

Datasource Concepts

Before setting up the datasource, learn about datasource concepts here

Step by Step Guide

STEP-1: Configure Connection

To learn about Connection, refer here

• Log into Sprinkle application

• Navigate to Datasources -> Connections Tab -> New Connection ->

• Select Zoho Books

• Provide all the mandatory details

  • Name: Name to identify this connection

  • Advance Settings: Refer here

• Connect to Zoho

• Test Connection

• Create

STEP-2: Configure Datasource

To learn about datasource, refer here

• Navigate to Datasources -> Datasources Tab -> Add ->

• Select Zoho Books

• Provide the name -> Create

• Connection Tab:

  • From the drop-down, select the name of connection created in STEP-2

  • Update

STEP-3: Create Dataset

Datasets Tab: To learn about Dataset, refer here. Add Dataset for each report/dataset that you want to integrate, providing following details

• Report Type (Required) : Type of report

  • Bank Accounts

  • Bank Accounts Rules

  • Bank Transactions

  • Base Currency Adjustment

  • Base Currency Adjustment Accounts

  • Bills

  • Chart Of Accounts

  • Chart Of Accounts Transactions

  • Contacts

  • Credit Notes

  • Credit Notes Templates

  • Currencies

  • Current User

  • Customer Payments

  • Employees

  • Estimates

  • Estimates Templates

  • Expenses

  • Journals

  • Invoices

  • Invoices Templates

  • Items

  • Opening Balance

  • Projects

  • Purchase Orders

  • Purchase Orders Templates

  • Recurring Bills

  • Recurring_Expenses

  • Recurring Invoices

  • Retainer Invoices

  • Retainer Invoices Templates

  • SalesOrder

  • SalesOrders Templates

  • Taxes

  • Tax Authorities

  • Tax Exemptions

  • Timer

  • Time Entries

  • Users

  • Vendor Credits

  • Vendor Credits Refunds

  • Vendor Payments

• Flatten Level(Required) : Select One Level or Multi Level. In one level, flattening will not be applied on complex type. They will be stored as string. In multi level, flattening will be applied in complex level till they become simple type.

• Destination Schema (Required) : Data warehouse schema where the table will be ingested into

• Destination Table name (Required) : It is the table name to be created on the warehouse. If not given, sprinkle will create like ds_<datasourcename>_<tablename>

• Destination Create Table Clause: Provide additional clauses to warehouse-create table queries such as clustering, partitioning, and more, useful for optimizing DML statements. Learn more on how to use this field.
• Create

STEP-4: Run and schedule Ingestion

In the Ingestion Jobs tab:

• Trigger the Job, using Run button

• To schedule, enable Auto-Run. Change the frequency if needed

Advanced Connection Setting

• API Read Timeout (In seconds) : Maximum time of inactivity between two data packets when waiting for the server's response. The default value is 30 seconds.

• API Connection Timeout (In seconds) : Time period within which a connection between a client and a server must be established.

• Retry Limit : Number of retries allowed when an API call fails. For example if an API call fails and retry limit is 5 then it will check 5 times for that API call and if it succeeded then it will stop checking.

• Retry Sleep Time (In milliseconds) : Given time, after which retry should happen in case an API call fails.

• Version : It gives information about the version of Zoho Books API being used.

• Domain : Select from dropdown ( .in, .com, .eu, .com.au )

Dataset Fields

Bank Accounts

• account_id

• account_name

• account_code

• currency_id

• currency_code

• account_type

• uncategorized_transactions

• total_unprinted_checks

• is_active

• balance

• bank_balance

• bcy_balance

• bank_name

• is_direct_paypal

Bank Transactions

• transaction_id

• from_account_id

• from_account_name

• to_account_id

• to_account_name

• transaction_type

• currency_id

• currency_code

• payment_mode

• exchange_rate

• date

• customer_id

• customer_name

• vendor_id

• reference_number

• description

• bank_charges tax_id

• documents

• is_inclusive_tax

• tax_name tax_percentage

• tax_amount

• sub_total tax_authority_id

• tax_authority_name

• tax_exemption_id

• tax_exemption_code

• total

• bcy_total

• amount

• vat_treatment

• product_type

• acquisition_vat_id

• acquisition_vat_name

• acquisition_vat_percentage

• acquisition_vat_amount

• reverse_charge_vat_id

• reverse_charge_vat_name

• reverse_charge_vat_percentage

• reverse_charge_vat_amount

• filed_in_vat_return_id

• filed_in_vat_return_name

• filed_in_vat_return_type

• imported_transactions

• tags

• line_items

Base Currency Adjustment

• base_currency_adjustment_id

• adjustment_date

• exchange_rate currency_id

• accounts

• notes

• currency_code

Bills

• bill_id

• purchaseorder_ids

• vendor_id

• vendor_name

• vat_treatment

• vat_reg_no

• source_of_supply

• destination_of_supply

• place_of_supply

• permit_number

• gst_no gst_treatment

• tax_treatment

• is_pre_gst

• pricebook_id

• pricebook_name

• is_reverse_charge_applied

• unused_credits_payable_amount

• status

• bill_number

• date

• due_date

• payment_terms

• payment_terms_label

• payment_expected_date

• reference_number

• recurring_bill_id

• due_by_days

• due_in_days

• currency_id

• currency_code

• currency_symbol

• documents

• price_precision

• exchange_rate

• adjustment

• adjustment_description

• custom_fields

• is_tds_applied

• is_item_level_tax_calc

• is_inclusive_tax

• filed_in_vat_return_id

• filed_in_vat_return_name

• filed_in_vat_return_type

• is_abn_quoted line_items

• sub_total tax_total total

• payment_made vendor_credits_applied

• is_line_item_invoiced

• purchaseorders

• taxes

• acquisition_vat_summary

• acquisition_vat_total

• reverse_charge_vat_summary

• reverse_charge_vat_total

• balance

• billing_address

• payments

• vendor_credits

• created_time

• created_by_id

• last_modified_time

• reference_id

• notes

• terms

• attachment_name

• open_purchaseorders_count

Chart Of Accounts

• account_id

• account_name

• account_code

• account_type

• description

• is_user_created

• is_system_account

• is_active

• can_show_in_ze

• parent_account_id

• parent_account_name

• depth

• has_attachment

• is_child_present child_count

• documents

• created_time

• is_standalone_account

• last_modified_time

Contacts

• contact_id

• contact_name

• company_name

• has_transaction

• contact_type

• customer_sub_type

• credit_limit

• is_portal_enabled

• language_code

• is_taxable tax_id

• tax_name

• tax_percentage

• tax_authority_id

• tax_exemption_id

• tax_authority_name

• tax_exemption_code

• place_of_contact

• gst_no vat_treatment

• tax_treatment

• gst_treatment

• is_linked_with_zohocrm

• website

• owner_id

• primary_contact_id

• payment_terms

• payment_terms_label

• currency_id

• currency_code

• currency_symbol

• opening_balance_amount

• exchange_rate

• outstanding_receivable_amount_bcy

• unused_credits_receivable_amount

• unused_credits_receivable_amount_bcy

• status

• payment_reminder_enabled

• custom_fields

• billing_address

• shipping_address

• facebook

• twitter

• contact_persons

• default_templates

• notes

• created_time

• last_modified_time

Credit Notes

• creditnote_id

• creditnote_number

• date

• is_pre_gst

• place_of_supply

• vat_treatment

• vat_reg_no

• gst_no

• gst_treatment

• tax_treatment

• status

• customer_id

• customer_name

• custom_fields

• reference_number

• email

• total

• balance

• line_items

• invoices

• taxes

• currency_code

• currency_symbol

• billing_address

• shipping_address

• created_time

• updated_time

• template_id

• template_name

• notes

• terms

Credit Notes Templates

• template_name

• template_id

• template_type

Currencies

• currency_id

• currency_code

• currency_name

• currency_name_formatted

• currency_symbol

• price_precision

• currency_format

• is_base_currency

• exchange_rate

• effective_date

Customer Payments

• payment_id

• payment_mode

• amount

• amount_refunded

• bank_charges

• date

• status

• reference_number

• description

• customer_id

• customer_name

• email

• invoices

• currency_code

• currency_symbol

• custom_fields

Estimates

• estimate_id

• estimate_number

• date

• reference_number

• is_pre_gst

• place_of_supply

• gst_no

• gst_treatment

• tax_treatment

• status

• customer_id

• customer_name

• contact_persons

• currency_id

• currency_code

• exchange_rate

• expiry_date

• discount

• is_discount_before_tax

• discount_type

• is_inclusive_tax line_items

• shipping_charge

• adjustment

• adjustment_description

• sub_total

• total

• tax_total

• price_precision

• taxes

• billing_address

• shipping_address

• notes

• terms

• custom_fields

• template_id

• template_name

• created_time

• last_modified_time

• salesperson_id

• salesperson_name

• project

Estimates Templates

• template_name

• template_id

• template_type

Expenses

• expense_id

• transaction_id

• transaction_type

• gst_no

• gst_treatment

• tax_treatment

• destination_of_supply

• destination_of_supply_state

• place_of_supply

• hsn_or_sac

• source_of_supply

• paid_through_account_name

• vat_reg_no

• reverse_charge_tax_id

• reverse_charge_tax_name

• reverse_charge_tax_percentage

• reverse_charge_tax_amount

• tax_amount

• is_itemized_expense

• is_pre_gst

• trip_id

• trip_number

• reverse_charge_vat_total

• acquisition_vat_total

• acquisition_vat_summary

• reverse_charge_vat_summary

• expense_item_id

• account_id

• account_name

• date

• tax_id

• tax_name

• tax_percentage

• currency_id

• currency_code

• exchange_rate

• sub_total

• total

• bcy_total

• amount

• is_inclusive_tax

• reference_number

• description

• is_billable

• is_personal

• customer_id

• customer_name

• expense_receipt_name

• expense_receipt_type

• last_modified_time

• status

• invoice_id

• invoice_number

• project_id

• project_name

• mileage_rate

• mileage_type

• expense_type

• start_reading

• end_reading

Invoices Templates

• template_name

• template_id

• template_type

Items

• item_id

• name

• status

• description

• rate

• unit

• tax_id

• tax_name

• hsn_or_sac

• tax_percentage

• tax_type

• sku

• product_type

• item_tax_preferences

• warehouses

Opening Balance

• opening_balance_id

• date

• price_precision

• accounts

• total

Projects

• project_id

• project_name

• customer_id

• customer_name

• currency_code

• description

• status

• billing_type

• rate

• budget_type

• total_hours

• total_amount

• billed_hours

• billed_amount

• un_billed_hours

• un_billed_amount

• billable_hours

• billable_amount

• non_billable_hours

• non_billable_amount

• cost_budget_amount

• is_recurrence_associated

• recurring_invoices

• created_time

• show_in_dashboard

• tasks

• users

Purchase Orders

• vendor_id

• contact_persons

• purchaseorder_number

• gst_treatment

• tax_treatment

• gst_no

• source_of_supply

• destination_of_supply

• place_of_supply

• pricebook_id

• reference_number

• billing_address_id

• crm_owner_id

• crm_custom_reference_id

• template_id

• date

• delivery_date

• due_date

• exchange_rate

• discount

• discount_account_id

• is_discount_before_tax

• is_inclusive_tax

• notes

• notes_default

• terms

• terms_default

• ship_via

• delivery_org_address_id

• delivery_customer_id

• attention

• vat_treatment

• is_update_customer

• salesorder_id

• line_items

• custom_fields

• documents

Purchase Orders Templates

• template_name

• template_id

• template_type

SalesOrder Templates

• template_name

• template_id

• template_type

Tax Authorities

• tax_authority_id

• tax_authority_name

• description

• registration_number

• registration_number_label

Users

• user_id

• role_id

• name

• email

• is_customer_segmented

• is_vendor_segmented

• user_role

• user_type

• status

• is_current_user

• photo_url

• is_employee