Zoho Subscription

Guide to integrate your Zoho Subscription with Sprinkle

Pipeline Concepts

Before setting up the Pipeline, learn about Pipeline concepts here

Step by Step Guide

STEP-1: Configure Connection

To learn about Connection, refer here

• Log into Sprinkle application

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

• Select Zoho Subscription

• Provide all the mandatory details

  • Name: Name to identify this connection

  • Advance Settings : Refer here

• Connect to Zoho

• Test Connection

• Create

STEP-2: Configure Pipeline

To learn about Pipeline, refer here

• Navigate to Ingest -> Pipeline Tab -> Add ->

• Select Zoho Subscriptions

• 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

• Organization (Required): Select the Organization whose data you want to access

• Report Type (Required): Type of Report

  • AddOns

  • Bank Accounts

  • Cards

  • Churn Messages Settings

  • Contact Persons

  • Coupons

  • Credit Notes

  • Customers

  • Events

  • Hosted Pages

  • Invoices

  • Payments

  • Plans

  • Products

  • Subscriptions

  • Tax Authorities

  • Taxes

  • Tax Exemptions

  • Transactions Unbilled Charges

  • Unbilled Charges

• 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_<Pipelinename>_<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 Settings

• 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 Subscription API being used.

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

Dataset Fields

AddOns

• addon_code

• name

• unit

• unit_name

• pricing_scheme

• price_brackets

• type

• interval_unit

• tags

• custom_fields

• applicable_to_all_plans

• plans

• status

• product_id

• description

• store_markup_description

• product_type

• hsn_or_sac

• item_tax_preferences

• tax_id

• created_time

• updated_time

Bank-Accounts

• account_id

• customer_id

• customer_name

• gateway

• last_four_digits

• status

• last_modified_time

• created_time

• created_by_id

• created_by_name

Cards

• customer_id

• card_id

• last_four_digits

• expiry_month

• expiry_year

• payment_gateway

• first_name

• last_name

• street

• city

• state

• zip

• country

• created_time

• updated_time

Contact Persons

• contactperson_id

• first_name

• last_name

• email

• mobile

• phone

• fax

• customer_id

• created_time

• updated_time

Coupons

• coupon_code

• name

• description

• type

• duration

• status

• discount_by

• discount_value

• product_id

• max_redemption

• redemption_count

• expiry_at

• apply_to_plans

• plans

• apply_to_addons

• addons

• created_time

• updated_time

Credit Notes

• creditnote_id

• creditnote_number

• date

• status

• customer_id

• customer_name

• custom_fields

• reference_number

• email

• total

• balance

• creditnote_items

• invoices

• taxes

• currency_code

• currency_symbol

• created_time

• updated_time

• template_id

• template_name

• notes

• terms

Customers

• customer_id

• display_name

• salutation

• first_name

• last_name

• email tags

• company_name

• phone

• mobile

• website

• is_portal_enabled

• department

• designation

• billing_address

• shipping_address

• currency_code

• currency_id

• ach_supported

• twitter

• facebook

• skype

• notes

• gst_no

• gst_treatment

• place_of_contact

• price_precision

• unused_credits

• outstanding

• status

• custom_fields

• zcrm_account_id

• zcrm_contact_id

• updated_time

• created_time

• source

• payment_terms

• payment_terms_

• label

• is_linked_with_zohocrm

• primary_contactperson_id

• can_add_card

• can_add_bank_account

• default_templates

• documents

Events

• event_id

• event_type

• event_time

• payload

• webhooks

Hosted Pages

• hostedpage_id

• status

• url

• action

• expiring_time

• created_time

• custom_fields

• data

Invoices

• invoice_id

• number

• status

• invoice_date

• due_date

• payment_expected_date

• ach_payment_initiated

• transaction_type

• customer_id

• customer_name

• email

• invoice_items

• coupons

• credits

• total

• payment_made

• balance

• credits_applied

• write_off_amount

• payments

• currency_code

• currency_symbol

• created_time

• updated_time

• salesperson_id

• salesperson_name

• invoice_url

• billing_address

• shipping_address

• comments

• custom_fields

• can_send_in_mail

• documents

Payments

• payment_id

• payment_mode

• amount

• amount_refunded

• bank_charges

• date

• status

• reference_number

• description

• customer_id

• customer_name

• email

• autotransaction

• invoices

• currency_code

• currency_symbol

• custom_fields

Plans

• plan_code

• name

• description

• store_markup_description

• status

• product_id

• account_id

• account_name

• tax_id

• trial_period

• setup_fee

• setup_fee_account_id

• setup_fee_account_name

• tags

• custom_fields

• recurring_price

• unit

• interval

• interval_unit

• billing_cycles

• product_type

• hsn_or_sac

• item_tax_preferences

• addons

• url

• created_time

• updated_time

Products

• created_time

• description

• email_ids

• name

• product_id

• redirect_url

• status

• updated_time

Subscriptions

• subscription_id

• name

• amount

• created_at

• activated_at

• current_term_starts_at

• current_term_ends_at

• last_billing_at

• next_billing_at

• expires_at

• interval

• interval_unit

• auto_collect

• created_time

• updated_time

• reference_id

• place_of_supply

• salesperson_id

• salesperson_name

• child_invoice_id

• currency_code

• currency_symbol

• end_of_term

• product_id

• product_name

• plan

• addons

• coupon

• card

• payment_terms

• payment_terms_label

• can_add_bank_account

• customer

• custom_fields

• taxes

• contactpersons

• notes

• payment_gateways

• unbilled_charge_id

• can_charge_setup_fee_immediately

Taxes

• tax_id

• tax_name

• tax_percentage

• tax_type

• tax_specific_type

• output_tax_account_name

• tax_account_id

• is_default_tax

• is_editable

• tax_specification

• diff_rate_reason

Unbilled Charges

• unbilled_charge_id

• number

• status

• unbilled_charge_date

• customer_id

• customer_name

• email

• unbilled_charge_items

• coupons

• total

• currency_code

• currency_symbol

• created_time

• updated_time

• billing_address

• shipping_address