Zoho Invoice
Guide to integrate your Zoho Invoice 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 Invoice
Provide all the mandatory details
Name: Name to identify this connection
Advance Setting: 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 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. 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_<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.
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
Last updated