# Zoho Subscription ## Pipeline Concepts Before setting up the Pipeline, learn about Pipeline concepts [here](https://docs.sprinkledata.com/product/ingesting-your-data/pipelines) ## Step by Step Guide ### STEP-1: Configure Connection To learn about Connection, refer [here](https://docs.sprinkledata.com/product/ingesting-your-data/pipelines) * 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](#advanced-connection-settings) * Connect to Zoho * Test Connection * Create ### STEP-2: Configure Pipeline To learn about Pipeline, refer [here](https://docs.sprinkledata.com/product/ingesting-your-data/pipelines) * 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](https://docs.sprinkledata.com/product/ingesting-your-data/pipelines). 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\_\\_\ * *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](https://docs.sprinkledata.com/product/ingesting-your-data/pipelines/databases/features/destination-create-table-clause) 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