# Zoho Invoice ## 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 Invoice * Provide all the mandatory details * *Name*: Name to identify this connection * *Advance Setting:* 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 Invoice * 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 * *Contacts* * *Credit Notes* * *Credit Notes Refunds* * *Credit Notes Templates* * *Credit Applied* * Due Date(Required): Date format will be yyyy-mm-dd. * *Currencies* * *Customer Payments* * Start Date(Required): Date format will be yyyy-mm-dd. It is the start date from it ingest the data from. * Window for backfill(Required): Mention window for backfill, for backfilling metrics in every run to include updates from attribution window. * *Customer Payments Refunds* * Customer Payments (Required): \ \- All Ids(Data will be fetched for all Customer Payments Ids present in Account)\ \- Multi Select(Data will be fetched for given Customer Payment Ids and dropdown will appear to select the id). * Customer Payment ID (Required): Select Customer Payment Ids for which data will be fetched. * *Employees* * *Estimates* * *Estimates Templates* * *Expenses* * *Expenses Categories* * *Invoices* * Start Date(Required): Date format will be yyyy-mm-dd. It is the start date from it ingest the data from. * Window for backfill(Required): Mention window for backfill, for backfilling metrics in every run to include updates from attribution window. * *Invoice Payments* * Due Date(Required): Date format will be yyyy-mm-dd. * *Invoice Templates* * *Items* * *Price\_Lists* * *Projects* * *Projects Time Entries* * *Recurring Expenses* * *Recurring Invoices* * *Retainer Invoices* * *Retainer Invoices Templates* * *Taxes* * *Tax Exemptions* * *Tax Authorities* * *Users* * 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. * **Max Records :** field sets the max limit on the number of records that can be downloaded during each API call. * **Incremental Batch Size (In days) :** No. of days in one batch for which data is being downloaded during incremental ingestion. * **Version :** it gives information about the version of Zoho Invoice API being used. * **Domain :** Select from dropdown ( .in, .com, .eu, .com.au ) ## Dataset Fields
Contacts * contact\_id * contact\_name * customer\_name * vendor\_name * company\_name * website * language\_code * language\_code\_formatted * contact\_type * contact\_type\_formatted * status * customer\_sub\_type * source * is\_linked\_with\_zohocrm * payment\_terms * payment\_terms\_label * currency\_id * twitter * facebook * currency\_code * outstanding\_receivable\_amount * outstanding\_receivable\_amount\_bcy * unused\_credits\_receivable\_amount * first\_name * last\_name * email * phone * mobile * portal\_status * created\_time * created\_time\_formatted * last\_modified\_time l * ast\_modified\_time\_formatted * custom\_fields * custom\_field\_hash * ach\_supported * has\_attachment
Credit Notes * creditnote\_id * creditnote\_number * status * reference\_number * date * total * balance * customer\_id * customer\_name * currency\_id * currency\_code * created\_time * last\_modified\_time * is\_emailed
Credit Notes Refund * creditnote\_refund\_id * creditnote\_id" * date * refund\_mode * reference\_number * creditnote\_number * customer\_name * description * amount\_bcy * amount\_fcy
Credit Notes Templates * template\_name * template\_id * template\_type
Credit Applied * creditnote\_id * creditnotes\_invoice\_id * creditnotes\_number * credited\_date * amount\_applied * creditnotes\_invoice\_id * creditnotes\_number * credited\_date * amount\_applied
Currencies * currency\_id * currency\_code * currency\_name * currency\_symbol * price\_precision * currency\_format * is\_base\_currency * exchange\_rate * effective\_date
Customer Payments * payment\_id * payment\_number * invoice\_numbers * date * payment\_mode * payment\_mode\_formatted * amount * bcy\_amount * unused\_amount * bcy\_unused\_amount * description * product\_description * reference\_number * customer\_id * customer\_name * created\_time * last\_modified\_time * last\_four\_digits * gateway\_transaction\_id * bcy\_refunded\_amount * applied\_invoices * has\_attachment * documents * custom\_fields\_list * tax\_amount\_withheld * payment\_type * settlement\_status
Customer Payments Refunds * payment\_refund\_id * payment\_id * date * refund\_mode * reference\_number * payment\_number * customer\_name * amount\_bcy * amount\_fcy
Employees * employee\_id * name * email
Estimates * estimate\_id * zcrm\_potential\_id * zcrm\_potential\_name * customer\_name * customer\_id * company\_name * status * color\_code * current\_sub\_status\_id * current\_sub\_status * estimate\_number * reference\_number * date currency\_id * currency\_code * total * created\_time * last\_modified\_time * accepted\_date * declined\_date * expiry\_date * has\_attachment * is\_viewed\_by\_client * client\_viewed\_time is\_emailed * is\_viewed\_in\_mail * template\_type * template\_id * mail\_first\_viewed\_time * mail\_last\_viewed\_time * salesperson\_id * salesperson\_name
Estimates Template * template\_name * template\_id * template\_type
Expenses * expense\_id * date * account\_name * description * currency\_id * currency\_code * bcy\_total * bcy\_total\_without\_tax * total * total\_without\_tax * is\_billable * reference\_number * customer\_id * customer\_name * status * created\_time * last\_modified\_time * expense\_receipt\_name * mileage\_rate * mileage\_unit * expense\_type * start\_reading * end\_reading
Expenses Categories * account\_id * account\_name * description * status
Invoice * invoice\_id * ach\_payment\_initiated * zcrm\_potential\_id * zcrm\_potential\_name * customer\_name * customer\_id * company\_name * status * color\_code * current\_sub\_status\_id * current\_sub\_status * invoice\_number * reference\_number * date due\_date * due\_days * currency\_id * schedule\_time * email * currency\_code * currency\_symbol * is\_pre\_gst * template\_type no\_of\_copies * show\_no\_of\_copies * is\_viewed\_by\_client * has\_attachment * client\_viewed\_time * invoice\_url type * project\_name * billing\_address\_address * billing\_address\_street2 * billing\_address\_city * billing\_address\_state * billing\_address\_zipcode * billing\_address\_country * billing\_address\_phone * billing\_address\_fax * billing\_address\_attention * shipping\_address\_address * shipping\_address\_street2 * shipping\_address\_city * shipping\_address\_state * shipping\_address\_zipcode * shipping\_address\_country * shipping\_address\_phone * shipping\_address\_fax * shipping\_address\_attention * country * phone * created\_by * updated\_time * transaction\_type * total balance * created\_time * last\_modified\_time * is\_emailed * is\_viewed\_in\_mail * mail\_first\_viewed\_time * mail\_last\_viewed\_time * reminders\_sent * last\_reminder\_sent\_date * payment\_expected\_date * last\_payment\_date * custom\_fields * custom\_field\_hash * template\_id * documents * salesperson\_id * salesperson\_name * shipping\_charge * adjustment * write\_off\_amount * exchange\_rate
Invoice Payments * payment\_id * payment\_number * invoice\_id * invoice\_payment\_id * payment\_mode * description * date * reference\_number * exchange\_rate * amount * tax\_amount\_withheld * online\_transaction\_id * is\_single\_invoice\_payment
Invoice Templates * template\_name * template\_id * template\_type
Items * item\_id * name * item\_name * unit * status * source * is\_linked\_with\_zohocrm * zcrm\_product\_id * description * rate * tax\_id * tax\_name * tax\_percentage * product\_type * has\_attachment * sku * image\_name * image\_type * image\_document\_id * created\_time * last\_modified\_time * show\_in\_storefront
Price Lists * pricebook\_id * name * description * currency\_id * "currency\_code * pricebook\_items * status * is\_default * pricebook\_type * is\_increase * rounding\_type * sales\_or\_purchase\_type
Projects * project\_id * project\_name * customer\_id * customer\_name * description * status * billing\_type * rate * created\_time * has\_attachment * total\_hours * billable\_hours
Projects Time Entries * time\_entry\_id * project\_id * project\_name * customer\_id * customer\_name * task\_id * task\_name * user\_id * is\_current\_user * user\_name * log\_date * begin\_time * end\_time * log\_time * is\_billable * billed\_status * invoice\_id * notes * timer\_started\_at * timer\_duration\_in\_minutes * created\_time
Recurring Expenses * recurring\_expense\_id * recurrence\_name * recurrence\_frequency * repeat\_every * last\_created\_date * next\_expense\_date * account\_name * description * currency\_id * currency\_code * total * is\_billable * customer\_name * status * created\_time * last\_modified\_time
Recurring Invoices * recurring\_invoice\_id * recurrence\_name * customer\_name * customer\_id * currency\_id * currency\_code * start\_date * end\_date * last\_sent\_date * next\_invoice\_date * line\_items * billing\_address * shipping\_address * payment\_gateways * payment\_options
Retainer Invoices * retainerinvoice\_id * customer\_name * retainerinvoice\_number * customer\_id * status * reference\_number * project\_or\_estimate\_name * date * currency\_id * currency\_code * is\_viewed\_by\_client * client\_viewed\_time * total * balance * created\_time * last\_modified\_time * is\_emailed * last\_payment\_date * has\_attachment
Retainer Invoices Templates * template\_name * template\_id * template\_type
Taxes * tax\_id * tax\_name * tax\_percentage * tax\_type * tax\_authority\_id * tax\_authority\_name" * is\_value\_added * is\_default\_tax * is\_editable
Tax Authorities * tax\_authority\_id * tax\_authority\_name * description * registration\_number * registration\_number\_label
Tax Exemptions * tax\_exemption\_id * tax\_exemption\_code * description * type * type\_formatted"
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