Zoho Invoice

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

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