Zoho Invoice Basic (Independent Publisher) (Preview)

Customize and create professional invoices, and get paid for your hard work. Zoho Invoice is online invoice management software for small businesses that is easy-to-use and completely free, forever.

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions except the following:      -   Azure Government regions      -   Azure China regions      -   US Department of Defense (DoD)

Contact
Name	Troy Taylor
URL	https://www.troystaylor.com
Email	troy@troystaylor.com

Connector Metadata
Publisher	Troy Taylor
Website	https://www.zoho.com/us/invoice/
Privacy policy	https://www.zoho.com/privacy.html
Categories	Finance;Sales and CRM

Creating a connection

The connector supports the following authentication types:

Default	Parameters for creating connection.	All regions	Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name	Type	Description	Required
Zoho Organization ID	string	The Zoho organization identifier for this api	True
Client ID	string	The Client ID for this api	True
Client Secret	securestring	The Client Secret for this api	True

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Create a contact	Creates a new contact.
Create an invoice	Creates an invoice for a customer.
Delete a contact	Deletes an existing contact.
Delete an invoice	Deletes an existing invoice. Invoices which have payment or credits note applied cannot be deleted.
Get a contact	Retrieve the details of an existing contact.
Get an invoice	Retrieve the details of an invoice
Get contacts	Retrieve a list of all contacts with pagination.
Get invoices	Retrieve a list of invoices with pagination.
Update a contact	Updates an existing contact.
Update an invoice	Update an existing invoice. To delete a line item just remove it from the line_items list.

Create a contact

Operation ID:

ContactPost

Creates a new contact.

Parameters

Name	Key	Required	Type	Description
Contact Name	contact_name	True	string	The contact name.
Company Name	company_name		string	The company name.
Payment Terms	payment_terms		integer	The payment terms.
Currency ID	currency_id		string	The currency identifier.
Website	website		string	The website.
Value	value		string	The custom field value.
Index	index		integer	The index number.
Attention	attention		string	The attention name.
Address	address		string	The address.
Address 2	street2		string	The address 2.
State	state_code		string	The state abbreviation.
City	city		string	The city.
State	state		string	The state.
Zip	zip		string	The zip code.
Country	country		string	The country.
Fax	fax		string	The fax number.
Phone	phone		string	The phone number.
Attention	attention		string	The attention name.
Address	address		string	The address.
Address 2	street2		string	The address 2.
State	state_code		string	The state abbreviation.
City	city		string	The city.
State	state		string	The state.
Zip	zip		string	The zip code.
Country	country		string	The country.
Fax	fax		string	The fax number.
Phone	phone		string	The phone number.
Salutation	salutation		string	The salutation.
First Name	first_name		string	The first name.
Last Name	last_name		string	The last name.
Email	email		string	The email address.
Phone	phone		string	The phone number.
Mobile	mobile		string	The mobile number.
Is Primary Contact	is_primary_contact		boolean	Whether is primary contact.
Invoice Template ID	invoice_template_id		string	The invoice template identifier.
Invoice Template Name	invoice_template_name		string	The invoice template name.
Estimate Template ID	estimate_template_id		string	The estimate template identifier.
Estimate Template Name	estimate_template_name		string	The estimate template name.
Credit Note Template ID	creditnote_template_id		string	The credit note template identifier.
Credit Note Template Name	creditnote_template_name		string	The credit note template name.
Invoice Email Template ID	invoice_email_template_id		string	The invoice email template identifier.
Invoice Email Template Name	invoice_email_template_name		string	The invoice email template name.
Estimate Email Template ID	estimate_email_template_id		string	The estimate email template identifier.
Estimate Email Template Name	estimate_email_template_name		string	The estimate email template name.
Credit Note Email Template ID	creditnote_email_template_id		string	The credit note email template identifier.
Credit Note Email Template Name	creditnote_email_template_name		string	The credit note email template name.
Language Code	language_code		string	The language code.
Notes	notes		string	The notes.
VAT Registration	vat_reg_no		string	The VAT registration number.
Tax Registration	tax_reg_no		string	The tax registration number.
Country Code	country_code		string	The country code.
VAT Treatment	vat_treatment		string	The VAT treatment type.
Tax Treatment	tax_treatment		string	The tax treatment type.
Tax Regime	tax_regime		string	The tax regime.
Legal Name	legal_name		string	The legal name.
Is TDS Registered	is_tds_registered		boolean	Whether is TDS registered.
Place Of Contact	place_of_contact		string	The place of contact.
GST Number	gst_no		string	The GST number.
GST Treatment	gst_treatment		string	The GST treatment type.
Tax Authority Name	tax_authority_name		string	The tax authority name.
Tax Exemption Code	tax_exemption_code		string	The tax exemption code.
AvaTax Exempt	avatax_exempt_no		string	The AvaTax exempt number.
AvaTax Use Code	avatax_use_code		string	The AvaTax use code.
Tax Exemption ID	tax_exemption_id		string	The tax exemption identifier.
Tax Authority ID	tax_authority_id		string	The tax authority identifier.
Tax ID	tax_id		string	The tax identifier.
TDS Tax ID	tds_tax_id		string	The TDS tax identifier.
Is Taxable	is_taxable		boolean	Whether is taxable.
Facebook	facebook		string	The Facebook username.
Twitter	twitter		string	The Twitter handle.

Returns

Name	Path	Type	Description
Status Code	code	integer	The status code.
Status Message	message	string	The status message.
Contact ID	contact.contact_id	string	The contact identifier.
Contact Name	contact.contact_name	string	The contact name.
Company Name	contact.company_name	string	The company name.
Has Transaction	contact.has_transaction	boolean	Whether has transaction.
Contact Type	contact.contact_type	string	The contact type.
Is Taxable	contact.is_taxable	boolean	Whether is taxable.
Tax ID	contact.tax_id	string	The tax identifier.
TDS Tax ID	contact.tds_tax_id	string	The TDS tax identifier.
Tax Name	contact.tax_name	string	The tax name.
Tax Percentage	contact.tax_percentage	integer	The tax percentage.
Tax Authority ID	contact.tax_authority_id	string	The tax authority identifier.
Tax Exemption ID	contact.tax_exemption_id	string	The tax exemption identifier.
Tax Authority Name	contact.tax_authority_name	string	The tax authority name.
Tax Exemption Code	contact.tax_exemption_code	string	The tax exemption code.
Place Of Contact	contact.place_of_contact	string	The place of contact.
GST Number	contact.gst_no	string	The GST number.
VAT Treatment	contact.vat_treatment	string	The VAT treatment.
Tax Treatment	contact.tax_treatment	string	The tax treatment.
Tax Regime	contact.tax_regime	string	The tax regime.
Legal Name	contact.legal_name	string	The legal name.
Is TDS Registered	contact.is_tds_registered	boolean	Whether the TSD is registered.
GST Treatment	contact.gst_treatment	string	The GST treatment.
Is Linked With Zoho CRM	contact.is_linked_with_zohocrm	boolean	Whether is linked with Zoho CRM.
Website	contact.website	string	The website.
Primary Contact ID	contact.primary_contact_id	string	The primary contact identifier.
Payment Terms	contact.payment_terms	integer	The payment terms.
Payment Terms Label	contact.payment_terms_label	string	The payment terms label.
Currency ID	contact.currency_id	string	The currency identifier.
Currency Code	contact.currency_code	string	The currency code.
Currency Symbol	contact.currency_symbol	string	The currency symbol.
Language Code	contact.language_code	string	The language code.
Outstanding Receivable Amount	contact.outstanding_receivable_amount	double	The outstanding receivable amount.
Outstanding Receivable Amount BCY	contact.outstanding_receivable_amount_bcy	double	The BCY outstanding receivable amount.
Unused Credits Receivable Amount	contact.unused_credits_receivable_amount	double	The unused credits receivable amount.
Unused Credits Receivable Amount BCY	contact.unused_credits_receivable_amount_bcy	double	The BCY unused credits receivable amount.
Status	contact.status	string	The status.
Payment Reminder Enabled	contact.payment_reminder_enabled	boolean	Whether payment reminder is enabled.
Custom Field	contact.custom_fields	array of object
Value	contact.custom_fields.value	string	The custom field value.
Index	contact.custom_fields.index	integer	The index number.
Label	contact.custom_fields.label	string	The label.
Attention	contact.billing_address.attention	string	The attention name.
Address	contact.billing_address.address	string	The address.
Street	contact.billing_address.street2	string	The street address.
State Code	contact.billing_address.state_code	string	The state code.
City	contact.billing_address.city	string	The city.
State	contact.billing_address.state	string	The state.
Zip	contact.billing_address.zip	string	The zip code.
Country	contact.billing_address.country	string	The country.
Fax	contact.billing_address.fax	string	The fax number.
Phone	contact.billing_address.phone	string	The phone number.
Attention	contact.shipping_address.attention	string	The attention name.
Address	contact.shipping_address.address	string	The address.
Street	contact.shipping_address.street2	string	The street address.
State Code	contact.shipping_address.state_code	string	The state code.
City	contact.shipping_address.city	string	The city.
State	contact.shipping_address.state	string	The state.
Zip	contact.shipping_address.zip	string	The zip code.
Country	contact.shipping_address.country	string	The country.
Fax	contact.shipping_address.fax	string	The fax number.
Phone	contact.shipping_address.phone	string	The phone number.
Facebook	contact.facebook	string	The Facebook account.
Twitter	contact.twitter	string	The Twitter handle.
Contact Persons	contact.contact_persons	array of object
Salutation	contact.contact_persons.salutation	string	The salutation.
First Name	contact.contact_persons.first_name	string	The first name.
Last Name	contact.contact_persons.last_name	string	The last name.
Email	contact.contact_persons.email	string	The email address.
Phone	contact.contact_persons.phone	string	The phone number.
Mobile	contact.contact_persons.mobile	string	The mobile number.
Is Primary Contact	contact.contact_persons.is_primary_contact	boolean	Whether is primary contact.
Invoice Template ID	contact.default_templates.invoice_template_id	string	The invoice template identifier.
Invoice Template Name	contact.default_templates.invoice_template_name	string	The invoice template name.
Estimate Template ID	contact.default_templates.estimate_template_id	string	The estimate template identifier.
Estimate Template Name	contact.default_templates.estimate_template_name	string	The estimate template name.
Credit Note Template ID	contact.default_templates.creditnote_template_id	string	The credit note template identifier.
Credit Note Template Name	contact.default_templates.creditnote_template_name	string	The credit note template name.
Invoice Email Template ID	contact.default_templates.invoice_email_template_id	string	The invoice email template identifier.
Invoice Email Template Name	contact.default_templates.invoice_email_template_name	string	The invoice email template name.
Estimate Email Template ID	contact.default_templates.estimate_email_template_id	string	The estimate email template identifier.
Estimate Email Template Name	contact.default_templates.estimate_email_template_name	string	The estimate email template name.
Credit Note Email Template ID	contact.default_templates.creditnote_email_template_id	string	The credit note email template identifier.
Credit Note Email Template Name	contact.default_templates.creditnote_email_template_name	string	The credit note email template name.
Notes	contact.notes	string	The notes.
Created Time	contact.created_time	string	The created time.
Last Modified Time	contact.last_modified_time	string	The last modified time.

Create an invoice

Operation ID:

InvoicePost

Creates an invoice for a customer.

Parameters

Name	Key	Required	Type	Description
Send	send		boolean	Whether to send the invoice.
Ignore Auto Number Generation	ignore_auto_number_generation		boolean	Whether to ignore auto number generation.
Customer ID	customer_id		string	The customer identifier.
Contact Person	contact_persons		array of integer	The contact person.
Invoice Number	invoice_number		string	The invoice number.
Reference Number	reference_number		string	The reference number.
Place Of Supply	place_of_supply		string	The place of supply.
Vat Treatment	vat_treatment		string	The VAT treatment.
GST Treatment	gst_treatment		string	The GST treatment.
Tax Treatment	tax_treatment		string	The tax treatment.
CFDI Usage	cfdi_usage		string	The CFDI usage.
GST Number	gst_no		string	The GST number.
Template ID	template_id		string	The template identifier.
Date	date		string	The date.
Payment Terms	payment_terms		integer	The payment terms.
Payment Terms Label	payment_terms_label		string	The payment terms label.
Due Date	due_date		string	The due date.
Discount	discount		float	The discount.
Is Discount Before Tax	is_discount_before_tax		boolean	Whether discount is before tax.
Discount Type	discount_type		string	The discount type.
Is Inclusive Tax	is_inclusive_tax		boolean	Whether is inclusive of tax.
Exchange Rate	exchange_rate		float	The exchange rate.
Recurring Invoice ID	recurring_invoice_id		string	The recurring invoice identifier.
Invoiced Estimate ID	invoiced_estimate_id		string	The invoiced estimate identifier.
Salesperson Name	salesperson_name		string	The salesperson name.
Label	label		string	The label.
Value	value		float	The value.
Project ID	project_id		string	The project identifier.
ID	item_id		string	The item identifier.
Project ID	project_id		string	The project identifier.
Time Entry IDs	time_entry_ids		array of integer	The time entry identifiers.
Expense ID	expense_id		string	The expense identifier.
Name	name		string	The name.
Product Type	product_type		string	The product type.
HSN Or SAC	hsn_or_sac		integer	The HSN or SAC number.
SAT Item Key Code	sat_item_key_code		integer	The SAT item key code.
Unit Key Code	unitkey_code		string	The unit key code.
Description	description		string	The description.
Order	item_order		integer	The item order.
Rate	rate		float	The rate.
Quantity	quantity		double	The quantity.
Unit	unit		string	The unit.
Discount	discount		float	The discount.
Tax ID	tax_id		string	The tax identifier.
TDS Tax ID	tds_tax_id		string	The TDS tax identifier.
Tax Exemption ID	tax_exemption_id		string	The tax exemption identifier.
AvaTax Use Code	avatax_use_code		string	The AvaTax use code.
AvaTax Exempt No	avatax_exempt_no		string	The AvaTax exempt number.
Tax Name	tax_name		string	The tax name.
Tax Type	tax_type		string	The tax type.
Tax Percentage	tax_percentage		float	The tax percentage.
Total	item_total		float	The item total.
Configured	configured		boolean	Whether configured.
Additional Field	additional_field1		string	The additional field.
Name	gateway_name		string	The name.
Allow Partial Payments	allow_partial_payments		boolean	Whether to allow partial payments.
Custom Body	custom_body		string	The custom body.
Custom Subject	custom_subject		string	The custom subject.
Notes	notes		string	The notes.
Terms	terms		string	The terms.
Shipping Charge	shipping_charge		float	The shipping charge.
Adjustment	adjustment		float	The adjustment.
Adjustment Description	adjustment_description		string	The adjustment description.
Reason	reason		string	The reason.
Tax Authority ID	tax_authority_id		string	The tax authority identifier.
Tax Exemption ID	tax_exemption_id		string	The tax exemption identifier.
AvaTax Use Code	avatax_use_code		string	The AvaTax use code.
AvaTax Tax Code	avatax_tax_code		string	The AvaTax tax code.
AvaTax Exempt Number	avatax_exempt_no		string	The AvaTax exempt number.

Returns

Name	Path	Type	Description
Status Code	code	integer	The status code.
Status Message	message	string	The status message.
ID	invoice.invoice_id	string	The invoice identifier.
ACH Payment Initiated	invoice.ach_payment_initiated	boolean	Whether ACH payment has been initiated.
Number	invoice.invoice_number	string	The invoice number.
Is Pre-GST	invoice.is_pre_gst	boolean	Whether is pre-GST.
Place Of Supply	invoice.place_of_supply	string	The place of supply.
GST Number	invoice.gst_no	string	The GST number.
GST Treatment	invoice.gst_treatment	string	The GST treatment.
Tax Treatment	invoice.tax_treatment	string	The tax treatment.
CFDI Usage	invoice.cfdi_usage	string	The CFDI usage.
VAT Treatment	invoice.vat_treatment	string	The VAT treatment.
VAT Registration	invoice.vat_reg_no	string	The VAT registration number.
Date	invoice.date	string	The date.
Status	invoice.status	string	The status.
Payment Terms	invoice.payment_terms	integer	The payment terms.
Payment Terms Label	invoice.payment_terms_label	string	The payment terms label.
Due Date	invoice.due_date	string	The due date.
Payment Expected Date	invoice.payment_expected_date	string	The payment expected date.
Last Payment Date	invoice.last_payment_date	string	The last payment date.
Reference Number	invoice.reference_number	string	The reference number.
Customer ID	invoice.customer_id	string	The customer identifier.
Customer Name	invoice.customer_name	string	The customer name.
Contact Persons	invoice.contact_persons	array of string	The contact persons.
Currency ID	invoice.currency_id	string	The currency identifier.
Currency Code	invoice.currency_code	string	The currency code.
Exchange Rate	invoice.exchange_rate	double	The exchange rate.
Discount	invoice.discount	double	The discount.
Is Discount Before Tax	invoice.is_discount_before_tax	boolean	Whether discount is before tax.
Discount Type	invoice.discount_type	string	The discount type.
Is Tax Inclusive	invoice.is_inclusive_tax	boolean	Whether is inclusive of tax.
Recurring Invoice ID	invoice.recurring_invoice_id	string	The recurring invoice identifier.
Is Viewed By Client	invoice.is_viewed_by_client	boolean	Whether is viewed by client.
Has Attachment	invoice.has_attachment	boolean	Whether has attachment.
Client Viewed Time	invoice.client_viewed_time	string	The client viewed time.
Line Item	invoice.line_items	array of object
ID	invoice.line_items.line_item_id	string	The line item identifier.
ID	invoice.line_items.item_id	string	The item identifier.
Project ID	invoice.line_items.project_id	string	The project identifier.
Project Name	invoice.line_items.project_name	string	The project name.
Item Type	invoice.line_items.item_type	string	The item type.
Product Type	invoice.line_items.product_type	string	The product type.
time_entry_ids	invoice.line_items.time_entry_ids	array of integer	time_entry_ids
Expense ID	invoice.line_items.expense_id	string	The expense identifier.
Expense Receipt Name	invoice.line_items.expense_receipt_name	string	The expense receipt name.
Name	invoice.line_items.name	string	The name.
Description	invoice.line_items.description	string	The description.
Item Order	invoice.line_items.item_order	integer	The item order.
BCY Rate	invoice.line_items.bcy_rate	double	The BCY rate.
Rate	invoice.line_items.rate	double	The rate.
Quantity	invoice.line_items.quantity	double	The quantity.
Unit	invoice.line_items.unit	string	The unit.
Discount Amount	invoice.line_items.discount_amount	double	The discount amount.
Discount	invoice.line_items.discount	double	The discount.
ID	invoice.line_items.tax_id	string	The tax identifier.
TDS Tax ID	invoice.line_items.tds_tax_id	string	The TDS tax identifier.
Name	invoice.line_items.tax_name	string	The tax name.
Tax Type	invoice.line_items.tax_type	string	The tax type.
Tax Percentage	invoice.line_items.tax_percentage	double	The tax percentage.
Item Total	invoice.line_items.item_total	double	The item total.
SAT Item Key Code	invoice.line_items.sat_item_key_code	integer	The SAT item key code.
Unit Key Code	invoice.line_items.unitkey_code	string	The unit key code.
Shipping Charge	invoice.shipping_charge	double	The shipping charge.
Adjustment	invoice.adjustment	double	The adjustment.
Adjustment Description	invoice.adjustment_description	string	The adjustment description.
Subtotal	invoice.sub_total	double	The subtotal.
Tax Total	invoice.tax_total	double	The tax total.
Total	invoice.total	double	The total.
Tax	invoice.taxes	array of object
Name	invoice.taxes.tax_name	string	The tax name.
Amount	invoice.taxes.tax_amount	double	The tax amount.
Payment Reminder Enabled	invoice.payment_reminder_enabled	boolean	Whether payment reminder is enabled.
Payment Made	invoice.payment_made	double	The payment made.
Credits Applied	invoice.credits_applied	double	The credits applied.
Tax Amount Withheld	invoice.tax_amount_withheld	double	The tax amount withheld.
Balance	invoice.balance	double	The balance.
Write Off Amount	invoice.write_off_amount	double	The write off amount.
Allow Partial Payments	invoice.allow_partial_payments	boolean	Whether to allow partial payments.
Price Precision	invoice.price_precision	integer	The price precision.
Gateway	invoice.payment_options.payment_gateways	array of object
Configured	invoice.payment_options.payment_gateways.configured	boolean	Whether configured.
Additional Field	invoice.payment_options.payment_gateways.additional_field1	string	The additional field.
Name	invoice.payment_options.payment_gateways.gateway_name	string	The gateway name.
Is Emailed	invoice.is_emailed	boolean	Whether has been emailed.
Reminders Sent	invoice.reminders_sent	integer	The number of reminders sent.
Last Reminder Sent Date	invoice.last_reminder_sent_date	string	The last reminder sent date.
Address	invoice.billing_address.address	string	The address.
City	invoice.billing_address.city	string	The city.
State	invoice.billing_address.state	string	The state.
Zip	invoice.billing_address.zip	string	The zip code.
Country	invoice.billing_address.country	string	The country.
Fax	invoice.billing_address.fax	string	The fax number.
Address	invoice.shipping_address.address	string	The address.
City	invoice.shipping_address.city	string	The city.
State	invoice.shipping_address.state	string	The state.
Zip	invoice.shipping_address.zip	string	The zip code.
Country	invoice.shipping_address.country	string	The country.
Fax	invoice.shipping_address.fax	string	The fax number.
Notes	invoice.notes	string	The notes.
Terms	invoice.terms	string	The terms.
Custom Field	invoice.custom_fields	array of object
ID	invoice.custom_fields.customfield_id	string	The custom field identifier.
Data Type	invoice.custom_fields.data_type	string	The data type.
Index	invoice.custom_fields.index	integer	The index number.
Label	invoice.custom_fields.label	string	The label.
Show On PDF	invoice.custom_fields.show_on_pdf	boolean	Whether to show on PDF.
Show In All PDFs	invoice.custom_fields.show_in_all_pdf	boolean	Whether to show in all PDFs.
Value	invoice.custom_fields.value	double	The custom field value.
Template ID	invoice.template_id	string	The template identifier.
Template Name	invoice.template_name	string	The template name.
Created Time	invoice.created_time	string	The created time.
Last Modified Time	invoice.last_modified_time	string	The last modified time.
Attachment Name	invoice.attachment_name	string	The attachment name.
Can Send In Mail	invoice.can_send_in_mail	boolean	Whether can send in mail.
Salesperson ID	invoice.salesperson_id	string	The salesperson identifier.
Salesperson Name	invoice.salesperson_name	string	The salesperson's name.
URL	invoice.invoice_url	string	The invoice URL address.

Delete a contact

Operation ID:

ContactDelete

Deletes an existing contact.

Parameters

Name	Key	Required	Type	Description
Contact ID	contact_id	True	string	The contact identifier.

Returns

Name	Path	Type	Description
Status Code	code	integer	The status code.
Status Message	message	string	The status message.

Delete an invoice

Operation ID:

InvoiceDelete

Deletes an existing invoice. Invoices which have payment or credits note applied cannot be deleted.

Parameters

Name	Key	Required	Type	Description
Invoice Identifier	invoice_id	True	string	The invoice identifier.

Returns

Name	Path	Type	Description
Status Code	code	integer	The status code.
Status Message	message	string	The status message.

Get a contact

Operation ID:

ContactGet

Retrieve the details of an existing contact.

Parameters

Name	Key	Required	Type	Description
Contact ID	contact_id	True	string	The contact identifier.

Returns

Name	Path	Type	Description
Status Code	code	integer	The status code.
Status Message	message	string	The status message.
Contact ID	contact.contact_id	string	The contact identifier.
Contact Name	contact.contact_name	string	The contact name.
Company Name	contact.company_name	string	The company name.
Has Transaction	contact.has_transaction	boolean	Whether has transaction.
Contact Type	contact.contact_type	string	The contact type.
Is Taxable	contact.is_taxable	boolean	Whether is taxable.
Tax ID	contact.tax_id	string	The tax identifier.
Tax Name	contact.tax_name	string	The tax name.
Tax Percentage	contact.tax_percentage	integer	The tax percentage.
Tax Authority ID	contact.tax_authority_id	string	The tax authority identifier.
Tax Exemption ID	contact.tax_exemption_id	string	The tax exemption identifier.
Tax Authority Name	contact.tax_authority_name	string	The tax authority name.
Tax Exemption Code	contact.tax_exemption_code	string	The tax exemption code.
Place Of Contact	contact.place_of_contact	string	The place of contact.
GST Number	contact.gst_no	string	The GST number.
VAT Treatment	contact.vat_treatment	string	The VAT treatment.
GST Treatment	contact.gst_treatment	string	The GST treatment.
Is Linked With Zoho CRM	contact.is_linked_with_zohocrm	boolean	Whether is linked with Zoho CRM.
Website	contact.website	string	The website.
Primary Contact ID	contact.primary_contact_id	string	The primary contact identifier.
Payment Terms	contact.payment_terms	integer	The payment terms.
Payment Terms Label	contact.payment_terms_label	string	The payment terms label.
Currency ID	contact.currency_id	string	The currency identifier.
Currency Code	contact.currency_code	string	The currency code.
Currency Symbol	contact.currency_symbol	string	The currency symbol.
Outstanding Receivable Amount	contact.outstanding_receivable_amount	double	The outstanding receivable amount.
Outstanding Receivable Amount BCY	contact.outstanding_receivable_amount_bcy	double	The BCY outstanding receivable amount.
Unused Credits Receivable Amount	contact.unused_credits_receivable_amount	double	The unused credits receivable amount.
Unused Credits Receivable Amount BCY	contact.unused_credits_receivable_amount_bcy	double	The BCY unused credits receivable amount.
Status	contact.status	string	The status.
Facebook	contact.facebook	string	The Facebook account.
Twitter	contact.twitter	string	The Twitter handle.
Payment Reminder Enabled	contact.payment_reminder_enabled	boolean	Whether payment reminder is enabled.
Custom Field	contact.custom_fields	array of object
Value	contact.custom_fields.value	string	The custom field value.
Index	contact.custom_fields.index	integer	The index number.
Label	contact.custom_fields.label	string	The label.
Attention	contact.billing_address.attention	string	The attention name.
Address	contact.billing_address.address	string	The address.
Street	contact.billing_address.street2	string	The street address.
State Code	contact.billing_address.state_code	string	The state code.
City	contact.billing_address.city	string	The city.
State	contact.billing_address.state	string	The state.
Zip	contact.billing_address.zip	string	The zip code.
Country	contact.billing_address.country	string	The country.
Fax	contact.billing_address.fax	string	The fax number.
Phone	contact.billing_address.phone	string	The phone number.
Attention	contact.shipping_address.attention	string	The attention name.
Address	contact.shipping_address.address	string	The address.
Street	contact.shipping_address.street2	string	The street address.
State Code	contact.shipping_address.state_code	string	The state code.
City	contact.shipping_address.city	string	The city.
State	contact.shipping_address.state	string	The state.
Zip	contact.shipping_address.zip	string	The zip code.
Country	contact.shipping_address.country	string	The country.
Fax	contact.shipping_address.fax	string	The fax number.
Phone	contact.shipping_address.phone	string	The phone number.
Contact Persons	contact.contact_persons	array of object
Salutation	contact.contact_persons.salutation	string	The salutation.
First Name	contact.contact_persons.first_name	string	The first name.
Last Name	contact.contact_persons.last_name	string	The last name.
Email	contact.contact_persons.email	string	The email address.
Phone	contact.contact_persons.phone	string	The phone number.
Mobile	contact.contact_persons.mobile	string	The mobile number.
Is Primary Contact	contact.contact_persons.is_primary_contact	boolean	Whether is primary contact.
Invoice Template ID	contact.default_templates.invoice_template_id	string	The invoice template identifier.
Invoice Template Name	contact.default_templates.invoice_template_name	string	The invoice template name.
Estimate Template ID	contact.default_templates.estimate_template_id	string	The estimate template identifier.
Estimate Template Name	contact.default_templates.estimate_template_name	string	The estimate template name.
Credit Note Template ID	contact.default_templates.creditnote_template_id	string	The credit note template identifier.
Credit Note Template Name	contact.default_templates.creditnote_template_name	string	The credit note template name.
Invoice Email Template ID	contact.default_templates.invoice_email_template_id	string	The invoice email template identifier.
Invoice Email Template Name	contact.default_templates.invoice_email_template_name	string	The invoice email template name.
Estimate Email Template ID	contact.default_templates.estimate_email_template_id	string	The estimate email template identifier.
Estimate Email Template Name	contact.default_templates.estimate_email_template_name	string	The estimate email template name.
Credit Note Email Template ID	contact.default_templates.creditnote_email_template_id	string	The credit note email template identifier.
Credit Note Email Template Name	contact.default_templates.creditnote_email_template_name	string	The credit note email template name.
Notes	contact.notes	string	The notes.
Created Time	contact.created_time	string	The created time.
Last Modified Time	contact.last_modified_time	string	The last modified time.

Get an invoice

Operation ID:

InvoiceGet

Retrieve the details of an invoice

Parameters

Name	Key	Required	Type	Description
Invoice Identifier	invoice_id	True	string	The invoice identifier.

Returns

Name	Path	Type	Description
Status Code	code	integer	The status code.
Status Message	message	string	The status message.
ID	invoice.invoice_id	string	The invoice identifier.
ACH Payment Initiated	invoice.ach_payment_initiated	boolean	Whether ACH payment has been initiated.
Number	invoice.invoice_number	string	The invoice number.
Is Pre-GST	invoice.is_pre_gst	boolean	Whether is pre-GST.
Place Of Supply	invoice.place_of_supply	string	The place of supply.
GST Number	invoice.gst_no	string	The GST number.
GST Treatment	invoice.gst_treatment	string	The GST treatment.
Tax Treatment	invoice.tax_treatment	string	The tax treatment.
CFDI Usage	invoice.cfdi_usage	string	The CFDI usage.
VAT Treatment	invoice.vat_treatment	string	The VAT treatment.
VAT Registration	invoice.vat_reg_no	string	The VAT registration number.
Date	invoice.date	string	The date.
Status	invoice.status	string	The status.
Payment Terms	invoice.payment_terms	integer	The payment terms.
Payment Terms Label	invoice.payment_terms_label	string	The payment terms label.
Due Date	invoice.due_date	string	The due date.
Payment Expected Date	invoice.payment_expected_date	string	The payment expected date.
Last Payment Date	invoice.last_payment_date	string	The last payment date.
Reference Number	invoice.reference_number	string	The reference number.
Customer ID	invoice.customer_id	string	The customer identifier.
Customer Name	invoice.customer_name	string	The customer name.
Contact Persons	invoice.contact_persons	array of string	The contact persons.
Currency ID	invoice.currency_id	string	The currency identifier.
Currency Code	invoice.currency_code	string	The currency code.
Exchange Rate	invoice.exchange_rate	double	The exchange rate.
Discount	invoice.discount	double	The discount.
Is Discount Before Tax	invoice.is_discount_before_tax	boolean	Whether discount is before tax.
Discount Type	invoice.discount_type	string	The discount type.
Is Tax Inclusive	invoice.is_inclusive_tax	boolean	Whether is inclusive of tax.
Recurring Invoice ID	invoice.recurring_invoice_id	string	The recurring invoice identifier.
Is Viewed By Client	invoice.is_viewed_by_client	boolean	Whether is viewed by client.
Has Attachment	invoice.has_attachment	boolean	Whether has attachment.
Client Viewed Time	invoice.client_viewed_time	string	The client viewed time.
Line Item	invoice.line_items	array of object
ID	invoice.line_items.line_item_id	string	The line item identifier.
ID	invoice.line_items.item_id	string	The item identifier.
Project ID	invoice.line_items.project_id	string	The project identifier.
Project Name	invoice.line_items.project_name	string	The project name.
Item Type	invoice.line_items.item_type	string	The item type.
Product Type	invoice.line_items.product_type	string	The product type.
time_entry_ids	invoice.line_items.time_entry_ids	array of integer	time_entry_ids
Expense ID	invoice.line_items.expense_id	string	The expense identifier.
Expense Receipt Name	invoice.line_items.expense_receipt_name	string	The expense receipt name.
Name	invoice.line_items.name	string	The name.
Description	invoice.line_items.description	string	The description.
Item Order	invoice.line_items.item_order	integer	The item order.
BCY Rate	invoice.line_items.bcy_rate	double	The BCY rate.
Rate	invoice.line_items.rate	double	The rate.
Quantity	invoice.line_items.quantity	double	The quantity.
Unit	invoice.line_items.unit	string	The unit.
Discount Amount	invoice.line_items.discount_amount	double	The discount amount.
Discount	invoice.line_items.discount	double	The discount.
ID	invoice.line_items.tax_id	string	The tax identifier.
TDS Tax ID	invoice.line_items.tds_tax_id	string	The TDS tax identifier.
Name	invoice.line_items.tax_name	string	The tax name.
Tax Type	invoice.line_items.tax_type	string	The tax type.
Tax Percentage	invoice.line_items.tax_percentage	double	The tax percentage.
Item Total	invoice.line_items.item_total	double	The item total.
SAT Item Key Code	invoice.line_items.sat_item_key_code	integer	The SAT item key code.
Unit Key Code	invoice.line_items.unitkey_code	string	The unit key code.
Shipping Charge	invoice.shipping_charge	double	The shipping charge.
Adjustment	invoice.adjustment	double	The adjustment.
Adjustment Description	invoice.adjustment_description	string	The adjustment description.
Subtotal	invoice.sub_total	double	The subtotal.
Tax Total	invoice.tax_total	double	The tax total.
Total	invoice.total	double	The total.
Tax	invoice.taxes	array of object
Name	invoice.taxes.tax_name	string	The tax name.
Amount	invoice.taxes.tax_amount	double	The tax amount.
Payment Reminder Enabled	invoice.payment_reminder_enabled	boolean	Whether payment reminder is enabled.
Payment Made	invoice.payment_made	double	The payment made.
Credits Applied	invoice.credits_applied	double	The credits applied.
Tax Amount Withheld	invoice.tax_amount_withheld	double	The tax amount withheld.
Balance	invoice.balance	double	The balance.
Write Off Amount	invoice.write_off_amount	double	The write off amount.
Allow Partial Payments	invoice.allow_partial_payments	boolean	Whether to allow partial payments.
Price Precision	invoice.price_precision	integer	The price precision.
Gateway	invoice.payment_options.payment_gateways	array of object
Configured	invoice.payment_options.payment_gateways.configured	boolean	Whether configured.
Additional Field	invoice.payment_options.payment_gateways.additional_field1	string	The additional field.
Name	invoice.payment_options.payment_gateways.gateway_name	string	The gateway name.
Is Emailed	invoice.is_emailed	boolean	Whether has been emailed.
Reminders Sent	invoice.reminders_sent	integer	The number of reminders sent.
Last Reminder Sent Date	invoice.last_reminder_sent_date	string	The last reminder sent date.
Address	invoice.billing_address.address	string	The address.
City	invoice.billing_address.city	string	The city.
State	invoice.billing_address.state	string	The state.
Zip	invoice.billing_address.zip	string	The zip code.
Country	invoice.billing_address.country	string	The country.
Fax	invoice.billing_address.fax	string	The fax number.
Address	invoice.shipping_address.address	string	The address.
City	invoice.shipping_address.city	string	The city.
State	invoice.shipping_address.state	string	The state.
Zip	invoice.shipping_address.zip	string	The zip code.
Country	invoice.shipping_address.country	string	The country.
Fax	invoice.shipping_address.fax	string	The fax number.
Notes	invoice.notes	string	The notes.
Terms	invoice.terms	string	The terms.
Custom Field	invoice.custom_fields	array of object
ID	invoice.custom_fields.customfield_id	string	The custom field identifier.
Data Type	invoice.custom_fields.data_type	string	The data type.
Index	invoice.custom_fields.index	integer	The index number.
Label	invoice.custom_fields.label	string	The label.
Show On PDF	invoice.custom_fields.show_on_pdf	boolean	Whether to show on PDF.
Show In All PDFs	invoice.custom_fields.show_in_all_pdf	boolean	Whether to show in all PDFs.
Value	invoice.custom_fields.value	double	The custom field value.
Template ID	invoice.template_id	string	The template identifier.
Template Name	invoice.template_name	string	The template name.
Created Time	invoice.created_time	string	The created time.
Last Modified Time	invoice.last_modified_time	string	The last modified time.
Attachment Name	invoice.attachment_name	string	The attachment name.
Can Send In Mail	invoice.can_send_in_mail	boolean	Whether can send in mail.
Salesperson ID	invoice.salesperson_id	string	The salesperson identifier.
Salesperson Name	invoice.salesperson_name	string	The salesperson's name.
URL	invoice.invoice_url	string	The invoice URL address.

Get contacts

Operation ID:

ContactsGet

Retrieve a list of all contacts with pagination.

Parameters

Name	Key	Required	Type	Description
Contact Name	contact_name		string	The contact name.
Company ID	company_name		string	The company identifier.
First Name	first_name		string	The first name.
Last Nam	last_name		string	The last name.
Address	address		string	The address.
Email	email		string	The email address.
Phone	phone		string	The phone address.
Filter By	filter_by		string	The filter by.
Search Text	search_text		string	The search text.
Sort Column	sort_column		string	The sort column.
Zoho CRM Contact ID	zcrm_contact_id		integer	The Zoho CRM contact identifier.
Zoho CRM Account ID	zcrm_account_id		integer	The Zoho CRM account identifier.
Page	page		integer	The page number.
Per Page	per_page		integer	The per page number.

Returns

Name	Path	Type	Description
Status Code	code	integer	The status code.
Status Message	message	string	The status message.
contact	contact	array of object
Contact ID	contact.contact_id	string	The contact identifier.
Contact Name	contact.contact_name	string	The contact name.
Company Name	contact.company_name	string	The company name.
Contact Type	contact.contact_type	string	The contact type.
Payment Terms	contact.payment_terms	integer	The payment terms.
Payment Terms Label	contact.payment_terms_label	string	The payment terms label.
Currency ID	contact.currency_id	string	The currency identifier.
Currency Code	contact.currency_code	string	The currency code.
Outstanding Receivable Amount	contact.outstanding_receivable_amount	double	The outstanding receivable amount.
Unused Credits Receivable Amount	contact.unused_credits_receivable_amount	double	The unused credits receivable amount.
Status	contact.status	string	The status.
Created Time	contact.created_time	string	The created time.
Last Modified Time	contact.last_modified_time	string	The last modified time.

Get invoices

Operation ID:

InvoicesGet

Retrieve a list of invoices with pagination.

Parameters

Name	Key	Required	Type	Description
Invoice Number	invoice_number		string	The invoice number.
Item Name	item_name		string	The item name.
Item ID	item_id		string	The item identifier.
Item Description	item_description		string	The item description.
Reference Number	reference_number		string	The reference number.
Customer Name	customer_name		string	The customer name.
Recurring Invoice ID	recurring_invoice_id		string	The recurring invoice identifier.
Email	email		string	The email address.
Total	total		string	The total.
Balance	balance		string	The balance.
Custom Field	custom_field		string	The custom field.
Date	date		string	The date.
Due Date	due_date		string	The due date.
Status	status		string	The status.
Custom ID	customer_id		string	The custom identifier.
Filter By	filter_by		string	The filter by.
Search Text	search_text		string	The search text.
Sort Column	sort_column		string	The sort column.
Zoho CRM Potential ID	zcrm_potential_id		string	The Zoho CRM potential identifier.
Page	page		integer	The page number.
Per Page	per_page		integer	The per page number.

Returns

Name	Path	Type	Description
Status Code	code	integer	The status code.
Status Message	message	string	The status message.
invoices	invoices	array of object
ID	invoices.invoice_id	string	The invoice identifier.
ACH Payment Initiated	invoices.ach_payment_initiated	boolean	Whether ACH payment has been initiated.
Number	invoices.invoice_number	string	The invoice number.
Is Pre-GST	invoices.is_pre_gst	boolean	Whether is pre-GST.
Place Of Supply	invoices.place_of_supply	string	The place of supply.
GST Number	invoices.gst_no	string	The GST number.
GST Treatment	invoices.gst_treatment	string	The GST treatment.
Tax Treatment	invoices.tax_treatment	string	The tax treatment.
CFDI Usage	invoices.cfdi_usage	string	The CFDI usage.
VAT Treatment	invoices.vat_treatment	string	The VAT treatment.
VAT Registration	invoices.vat_reg_no	string	The VAT registration number.
Date	invoices.date	string	The date.
Status	invoices.status	string	The status.
Payment Terms	invoices.payment_terms	integer	The payment terms.
Payment Terms Label	invoices.payment_terms_label	string	The payment terms label.
Due Date	invoices.due_date	string	The due date.
Payment Expected Date	invoices.payment_expected_date	string	The payment expected date.
Last Payment Date	invoices.last_payment_date	string	The last payment date.
Reference Number	invoices.reference_number	string	The reference number.
Customer ID	invoices.customer_id	string	The customer identifier.
Customer Name	invoices.customer_name	string	The customer name.
Contact Persons	invoices.contact_persons	array of string	The contact persons.
Currency ID	invoices.currency_id	string	The currency identifier.
Currency Code	invoices.currency_code	string	The currency code.
Exchange Rate	invoices.exchange_rate	double	The exchange rate.
Discount	invoices.discount	double	The discount.
Is Discount Before Tax	invoices.is_discount_before_tax	boolean	Whether discount is before tax.
Discount Type	invoices.discount_type	string	The discount type.
Is Tax Inclusive	invoices.is_inclusive_tax	boolean	Whether is inclusive of tax.
Recurring Invoice ID	invoices.recurring_invoice_id	string	The recurring invoice identifier.
Is Viewed By Client	invoices.is_viewed_by_client	boolean	Whether is viewed by client.
Has Attachment	invoices.has_attachment	boolean	Whether has attachment.
Client Viewed Time	invoices.client_viewed_time	string	The client viewed time.
Line Item	invoices.line_items	array of object
ID	invoices.line_items.line_item_id	string	The line item identifier.
ID	invoices.line_items.item_id	string	The item identifier.
Project ID	invoices.line_items.project_id	string	The project identifier.
Project Name	invoices.line_items.project_name	string	The project name.
Item Type	invoices.line_items.item_type	string	The item type.
Product Type	invoices.line_items.product_type	string	The product type.
time_entry_ids	invoices.line_items.time_entry_ids	array of integer	time_entry_ids
Expense ID	invoices.line_items.expense_id	string	The expense identifier.
Expense Receipt Name	invoices.line_items.expense_receipt_name	string	The expense receipt name.
Name	invoices.line_items.name	string	The name.
Description	invoices.line_items.description	string	The description.
Item Order	invoices.line_items.item_order	integer	The item order.
BCY Rate	invoices.line_items.bcy_rate	double	The BCY rate.
Rate	invoices.line_items.rate	double	The rate.
Quantity	invoices.line_items.quantity	double	The quantity.
Unit	invoices.line_items.unit	string	The unit.
Discount Amount	invoices.line_items.discount_amount	double	The discount amount.
Discount	invoices.line_items.discount	double	The discount.
ID	invoices.line_items.tax_id	string	The tax identifier.
TDS Tax ID	invoices.line_items.tds_tax_id	string	The TDS tax identifier.
Name	invoices.line_items.tax_name	string	The tax name.
Tax Type	invoices.line_items.tax_type	string	The tax type.
Tax Percentage	invoices.line_items.tax_percentage	double	The tax percentage.
Item Total	invoices.line_items.item_total	double	The item total.
SAT Item Key Code	invoices.line_items.sat_item_key_code	integer	The SAT item key code.
Unit Key Code	invoices.line_items.unitkey_code	string	The unit key code.
Shipping Charge	invoices.shipping_charge	double	The shipping charge.
Adjustment	invoices.adjustment	double	The adjustment.
Adjustment Description	invoices.adjustment_description	string	The adjustment description.
Subtotal	invoices.sub_total	double	The subtotal.
Tax Total	invoices.tax_total	double	The tax total.
Total	invoices.total	double	The total.
Tax	invoices.taxes	array of object
Name	invoices.taxes.tax_name	string	The tax name.
Amount	invoices.taxes.tax_amount	double	The tax amount.
Payment Reminder Enabled	invoices.payment_reminder_enabled	boolean	Whether payment reminder is enabled.
Payment Made	invoices.payment_made	double	The payment made.
Credits Applied	invoices.credits_applied	double	The credits applied.
Tax Amount Withheld	invoices.tax_amount_withheld	double	The tax amount withheld.
Balance	invoices.balance	double	The balance.
Write Off Amount	invoices.write_off_amount	double	The write off amount.
Allow Partial Payments	invoices.allow_partial_payments	boolean	Whether to allow partial payments.
Price Precision	invoices.price_precision	integer	The price precision.
Gateway	invoices.payment_options.payment_gateways	array of object
Configured	invoices.payment_options.payment_gateways.configured	boolean	Whether configured.
Additional Field	invoices.payment_options.payment_gateways.additional_field1	string	The additional field.
Name	invoices.payment_options.payment_gateways.gateway_name	string	The gateway name.
Is Emailed	invoices.is_emailed	boolean	Whether has been emailed.
Reminders Sent	invoices.reminders_sent	integer	The number of reminders sent.
Last Reminder Sent Date	invoices.last_reminder_sent_date	string	The last reminder sent date.
Address	invoices.billing_address.address	string	The address.
City	invoices.billing_address.city	string	The city.
State	invoices.billing_address.state	string	The state.
Zip	invoices.billing_address.zip	string	The zip code.
Country	invoices.billing_address.country	string	The country.
Fax	invoices.billing_address.fax	string	The fax number.
Address	invoices.shipping_address.address	string	The address.
City	invoices.shipping_address.city	string	The city.
State	invoices.shipping_address.state	string	The state.
Zip	invoices.shipping_address.zip	string	The zip code.
Country	invoices.shipping_address.country	string	The country.
Fax	invoices.shipping_address.fax	string	The fax number.
Notes	invoices.notes	string	The notes.
Terms	invoices.terms	string	The terms.
Custom Field	invoices.custom_fields	array of object
ID	invoices.custom_fields.customfield_id	string	The custom field identifier.
Data Type	invoices.custom_fields.data_type	string	The data type.
Index	invoices.custom_fields.index	integer	The index number.
Label	invoices.custom_fields.label	string	The label.
Show On PDF	invoices.custom_fields.show_on_pdf	boolean	Whether to show on PDF.
Show In All PDFs	invoices.custom_fields.show_in_all_pdf	boolean	Whether to show in all PDFs.
Value	invoices.custom_fields.value	double	The custom field value.
Template ID	invoices.template_id	string	The template identifier.
Template Name	invoices.template_name	string	The template name.
Created Time	invoices.created_time	string	The created time.
Last Modified Time	invoices.last_modified_time	string	The last modified time.
Attachment Name	invoices.attachment_name	string	The attachment name.
Can Send In Mail	invoices.can_send_in_mail	boolean	Whether can send in mail.
Salesperson ID	invoices.salesperson_id	string	The salesperson identifier.
Salesperson Name	invoices.salesperson_name	string	The salesperson's name.
URL	invoices.invoice_url	string	The invoice URL address.

Update a contact

Operation ID:

ContactPut

Updates an existing contact.

Parameters

Name	Key	Required	Type	Description
Contact ID	contact_id	True	string	The contact identifier.
Contact Name	contact_name	True	string	The contact name.
Company Name	company_name		string	The company name.
Payment Terms	payment_terms		integer	The payment terms.
Currency ID	currency_id		string	The currency identifier.
Website	website		string	The website.
Value	value		string	The custom field value.
Index	index		integer	The index number.
Label	label		string	The label.
Attention	attention		string	The attention name.
Address	address		string	The address.
Address 2	street2		string	The address 2.
State	state_code		string	The state abbreviation.
City	city		string	The city.
State	state		string	The state.
Zip	zip		string	The zip code.
Country	country		string	The country.
Fax	fax		string	The fax number.
Phone	phone		string	The phone number.
Attention	attention		string	The attention name.
Address	address		string	The address.
Address 2	street2		string	The address 2.
State	state_code		string	The state abbreviation.
City	city		string	The city.
State	state		string	The state.
Zip	zip		string	The zip code.
Country	country		string	The country.
Fax	fax		string	The fax number.
Phone	phone		string	The phone number.
Salutation	salutation		string	The salutation.
First Name	first_name		string	The first name.
Last Name	last_name		string	The last name.
Email	email		string	The email address.
Phone	phone		string	The phone number.
Mobile	mobile		string	The mobile number.
Is Primary Contact	is_primary_contact		boolean	Whether is primary contact.
Invoice Template ID	invoice_template_id		string	The invoice template identifier.
Invoice Template Name	invoice_template_name		string	The invoice template name.
Estimate Template ID	estimate_template_id		string	The estimate template identifier.
Estimate Template Name	estimate_template_name		string	The estimate template name.
Credit Note Template ID	creditnote_template_id		string	The credit note template identifier.
Credit Note Template Name	creditnote_template_name		string	The credit note template name.
Invoice Email Template ID	invoice_email_template_id		string	The invoice email template identifier.
Invoice Email Template Name	invoice_email_template_name		string	The invoice email template name.
Estimate Email Template ID	estimate_email_template_id		string	The estimate email template identifier.
Estimate Email Template Name	estimate_email_template_name		string	The estimate email template name.
Credit Note Email Template ID	creditnote_email_template_id		string	The credit note email template identifier.
Credit Note Email Template Name	creditnote_email_template_name		string	The credit note email template name.
Language Code	language_code		string	The language code.
Notes	notes		string	The notes.
VAT Registration	vat_reg_no		string	The VAT registration number.
Tax Registration	tax_reg_no		string	The tax registration number.
Country Code	country_code		string	The country code.
VAT Treatment	vat_treatment		string	The VAT treatment type.
Tax Treatment	tax_treatment		string	The tax treatment type.
Tax Regime	tax_regime		string	The tax regime.
Legal Name	legal_name		string	The legal name.
Is TDS Registered	is_tds_registered		boolean	Whether is TDS registered.
Place Of Contact	place_of_contact		string	The place of contact.
GST Number	gst_no		string	The GST number.
GST Treatment	gst_treatment		string	The GST treatment type.
Tax Authority Name	tax_authority_name		string	The tax authority name.
Tax Exemption Code	tax_exemption_code		string	The tax exemption code.
AvaTax Exempt	avatax_exempt_no		string	The AvaTax exempt number.
AvaTax Use Code	avatax_use_code		string	The AvaTax use code.
Tax Exemption ID	tax_exemption_id		string	The tax exemption identifier.
Tax Authority ID	tax_authority_id		string	The tax authority identifier.
Tax ID	tax_id		string	The tax identifier.
TDS Tax ID	tds_tax_id		string	The TDS tax identifier.
Is Taxable	is_taxable		boolean	Whether is taxable.
Facebook	facebook		string	The Facebook username.
Twitter	twitter		string	The Twitter handle.

Returns

Name	Path	Type	Description
Status Code	code	integer	The status code.
Status Message	message	string	The status message.
Contact ID	contact.contact_id	string	The contact identifier.
Contact Name	contact.contact_name	string	The contact name.
Company Name	contact.company_name	string	The company name.
Has Transaction	contact.has_transaction	boolean	Whether has transaction.
Contact Type	contact.contact_type	string	The contact type.
Is Taxable	contact.is_taxable	boolean	Whether is taxable.
Tax ID	contact.tax_id	string	The tax identifier.
TDS Tax ID	contact.tds_tax_id	string	The TDS tax identifier.
Tax Name	contact.tax_name	string	The tax name.
Tax Percentage	contact.tax_percentage	integer	The tax percentage.
Tax Authority ID	contact.tax_authority_id	string	The tax authority identifier.
Tax Exemption ID	contact.tax_exemption_id	string	The tax exemption identifier.
Tax Authority Name	contact.tax_authority_name	string	The tax authority name.
Tax Exemption Code	contact.tax_exemption_code	string	The tax exemption code.
Place Of Contact	contact.place_of_contact	string	The place of contact.
GST Number	contact.gst_no	string	The GST number.
VAT Treatment	contact.vat_treatment	string	The VAT treatment.
Tax Treatment	contact.tax_treatment	string	The tax treatment.
Tax Regime	contact.tax_regime	string	The tax regime.
Legal Name	contact.legal_name	string	The legal name.
Is TDS Registered	contact.is_tds_registered	boolean	Whether the TSD is registered.
GST Treatment	contact.gst_treatment	string	The GST treatment.
Is Linked With Zoho CRM	contact.is_linked_with_zohocrm	boolean	Whether is linked with Zoho CRM.
Website	contact.website	string	The website.
Primary Contact ID	contact.primary_contact_id	string	The primary contact identifier.
Payment Terms	contact.payment_terms	integer	The payment terms.
Payment Terms Label	contact.payment_terms_label	string	The payment terms label.
Currency ID	contact.currency_id	string	The currency identifier.
Currency Code	contact.currency_code	string	The currency code.
Currency Symbol	contact.currency_symbol	string	The currency symbol.
Language Code	contact.language_code	string	The language code.
Outstanding Receivable Amount	contact.outstanding_receivable_amount	double	The outstanding receivable amount.
Outstanding Receivable Amount BCY	contact.outstanding_receivable_amount_bcy	double	The BCY outstanding receivable amount.
Unused Credits Receivable Amount	contact.unused_credits_receivable_amount	double	The unused credits receivable amount.
Unused Credits Receivable Amount BCY	contact.unused_credits_receivable_amount_bcy	double	The BCY unused credits receivable amount.
Status	contact.status	string	The status.
Payment Reminder Enabled	contact.payment_reminder_enabled	boolean	Whether payment reminder is enabled.
Custom Field	contact.custom_fields	array of object
Value	contact.custom_fields.value	string	The custom field value.
Index	contact.custom_fields.index	integer	The index number.
Label	contact.custom_fields.label	string	The label.
Attention	contact.billing_address.attention	string	The attention name.
Address	contact.billing_address.address	string	The address.
Street	contact.billing_address.street2	string	The street address.
State Code	contact.billing_address.state_code	string	The state code.
City	contact.billing_address.city	string	The city.
State	contact.billing_address.state	string	The state.
Zip	contact.billing_address.zip	string	The zip code.
Country	contact.billing_address.country	string	The country.
Fax	contact.billing_address.fax	string	The fax number.
Phone	contact.billing_address.phone	string	The phone number.
Attention	contact.shipping_address.attention	string	The attention name.
Address	contact.shipping_address.address	string	The address.
Street	contact.shipping_address.street2	string	The street address.
State Code	contact.shipping_address.state_code	string	The state code.
City	contact.shipping_address.city	string	The city.
State	contact.shipping_address.state	string	The state.
Zip	contact.shipping_address.zip	string	The zip code.
Country	contact.shipping_address.country	string	The country.
Fax	contact.shipping_address.fax	string	The fax number.
Phone	contact.shipping_address.phone	string	The phone number.
Facebook	contact.facebook	string	The Facebook account.
Twitter	contact.twitter	string	The Twitter handle.
Contact Persons	contact.contact_persons	array of object
Salutation	contact.contact_persons.salutation	string	The salutation.
First Name	contact.contact_persons.first_name	string	The first name.
Last Name	contact.contact_persons.last_name	string	The last name.
Email	contact.contact_persons.email	string	The email address.
Phone	contact.contact_persons.phone	string	The phone number.
Mobile	contact.contact_persons.mobile	string	The mobile number.
Is Primary Contact	contact.contact_persons.is_primary_contact	boolean	Whether is primary contact.
Invoice Template ID	contact.default_templates.invoice_template_id	string	The invoice template identifier.
Invoice Template Name	contact.default_templates.invoice_template_name	string	The invoice template name.
Estimate Template ID	contact.default_templates.estimate_template_id	string	The estimate template identifier.
Estimate Template Name	contact.default_templates.estimate_template_name	string	The estimate template name.
Credit Note Template ID	contact.default_templates.creditnote_template_id	string	The credit note template identifier.
Credit Note Template Name	contact.default_templates.creditnote_template_name	string	The credit note template name.
Invoice Email Template ID	contact.default_templates.invoice_email_template_id	string	The invoice email template identifier.
Invoice Email Template Name	contact.default_templates.invoice_email_template_name	string	The invoice email template name.
Estimate Email Template ID	contact.default_templates.estimate_email_template_id	string	The estimate email template identifier.
Estimate Email Template Name	contact.default_templates.estimate_email_template_name	string	The estimate email template name.
Credit Note Email Template ID	contact.default_templates.creditnote_email_template_id	string	The credit note email template identifier.
Credit Note Email Template Name	contact.default_templates.creditnote_email_template_name	string	The credit note email template name.
Notes	contact.notes	string	The notes.
Created Time	contact.created_time	string	The created time.
Last Modified Time	contact.last_modified_time	string	The last modified time.

Update an invoice

Operation ID:

InvoicePut

Update an existing invoice. To delete a line item just remove it from the line_items list.

Parameters

Name	Key	Required	Type	Description
Invoice Identifier	invoice_id	True	string	The invoice identifier.
Customer ID	customer_id		string	The customer identifier.
Contact Person	contact_persons		array of integer	The contact person.
Invoice Number	invoice_number		string	The invoice number.
Reference Number	reference_number		string	The reference number.
Place Of Supply	place_of_supply		string	The place of supply.
Vat Treatment	vat_treatment		string	The VAT treatment.
GST Treatment	gst_treatment		string	The GST treatment.
Tax Treatment	tax_treatment		string	The tax treatment.
CFDI Usage	cfdi_usage		string	The CFDI usage.
GST Number	gst_no		string	The GST number.
Template ID	template_id		string	The template identifier.
Date	date		string	The date.
Payment Terms	payment_terms		integer	The payment terms.
Payment Terms Label	payment_terms_label		string	The payment terms label.
Due Date	due_date		string	The due date.
Discount	discount		float	The discount.
Is Discount Before Tax	is_discount_before_tax		boolean	Whether discount is before tax.
Discount Type	discount_type		string	The discount type.
Is Inclusive Tax	is_inclusive_tax		boolean	Whether is inclusive of tax.
Exchange Rate	exchange_rate		float	The exchange rate.
Recurring Invoice ID	recurring_invoice_id		string	The recurring invoice identifier.
Invoiced Estimate ID	invoiced_estimate_id		string	The invoiced estimate identifier.
Salesperson Name	salesperson_name		string	The salesperson name.
Label	label		string	The label.
Value	value		float	The value.
Project ID	project_id		string	The project identifier.
ID	item_id		string	The item identifier.
Project ID	project_id		string	The project identifier.
Time Entry IDs	time_entry_ids		array of integer	The time entry identifiers.
Expense ID	expense_id		string	The expense identifier.
Name	name		string	The name.
Product Type	product_type		string	The product type.
HSN Or SAC	hsn_or_sac		integer	The HSN or SAC number.
SAT Item Key Code	sat_item_key_code		integer	The SAT item key code.
Unit Key Code	unitkey_code		string	The unit key code.
Description	description		string	The description.
Order	item_order		integer	The item order.
Rate	rate		float	The rate.
Quantity	quantity		double	The quantity.
Unit	unit		string	The unit.
Discount	discount		float	The discount.
Tax ID	tax_id		string	The tax identifier.
TDS Tax ID	tds_tax_id		string	The TDS tax identifier.
Tax Exemption ID	tax_exemption_id		string	The tax exemption identifier.
AvaTax Use Code	avatax_use_code		string	The AvaTax use code.
AvaTax Exempt No	avatax_exempt_no		string	The AvaTax exempt number.
Tax Name	tax_name		string	The tax name.
Tax Type	tax_type		string	The tax type.
Tax Percentage	tax_percentage		float	The tax percentage.
Total	item_total		float	The item total.
Configured	configured		boolean	Whether configured.
Additional Field	additional_field1		string	The additional field.
Name	gateway_name		string	The name.
Allow Partial Payments	allow_partial_payments		boolean	Whether to allow partial payments.
Custom Body	custom_body		string	The custom body.
Custom Subject	custom_subject		string	The custom subject.
Notes	notes		string	The notes.
Terms	terms		string	The terms.
Shipping Charge	shipping_charge		float	The shipping charge.
Adjustment	adjustment		float	The adjustment.
Adjustment Description	adjustment_description		string	The adjustment description.
Reason	reason		string	The reason.
Tax Authority ID	tax_authority_id		string	The tax authority identifier.
Tax Exemption ID	tax_exemption_id		string	The tax exemption identifier.
AvaTax Use Code	avatax_use_code		string	The AvaTax use code.
AvaTax Tax Code	avatax_tax_code		string	The AvaTax tax code.
AvaTax Exempt Number	avatax_exempt_no		string	The AvaTax exempt number.

Returns

Name	Path	Type	Description
Status Code	code	integer	The status code.
Status Message	message	string	The status message.
ID	invoice.invoice_id	string	The invoice identifier.
ACH Payment Initiated	invoice.ach_payment_initiated	boolean	Whether ACH payment has been initiated.
Number	invoice.invoice_number	string	The invoice number.
Is Pre-GST	invoice.is_pre_gst	boolean	Whether is pre-GST.
Place Of Supply	invoice.place_of_supply	string	The place of supply.
GST Number	invoice.gst_no	string	The GST number.
GST Treatment	invoice.gst_treatment	string	The GST treatment.
Tax Treatment	invoice.tax_treatment	string	The tax treatment.
CFDI Usage	invoice.cfdi_usage	string	The CFDI usage.
VAT Treatment	invoice.vat_treatment	string	The VAT treatment.
VAT Registration	invoice.vat_reg_no	string	The VAT registration number.
Date	invoice.date	string	The date.
Status	invoice.status	string	The status.
Payment Terms	invoice.payment_terms	integer	The payment terms.
Payment Terms Label	invoice.payment_terms_label	string	The payment terms label.
Due Date	invoice.due_date	string	The due date.
Payment Expected Date	invoice.payment_expected_date	string	The payment expected date.
Last Payment Date	invoice.last_payment_date	string	The last payment date.
Reference Number	invoice.reference_number	string	The reference number.
Customer ID	invoice.customer_id	string	The customer identifier.
Customer Name	invoice.customer_name	string	The customer name.
Contact Persons	invoice.contact_persons	array of string	The contact persons.
Currency ID	invoice.currency_id	string	The currency identifier.
Currency Code	invoice.currency_code	string	The currency code.
Exchange Rate	invoice.exchange_rate	double	The exchange rate.
Discount	invoice.discount	double	The discount.
Is Discount Before Tax	invoice.is_discount_before_tax	boolean	Whether discount is before tax.
Discount Type	invoice.discount_type	string	The discount type.
Is Tax Inclusive	invoice.is_inclusive_tax	boolean	Whether is inclusive of tax.
Recurring Invoice ID	invoice.recurring_invoice_id	string	The recurring invoice identifier.
Is Viewed By Client	invoice.is_viewed_by_client	boolean	Whether is viewed by client.
Has Attachment	invoice.has_attachment	boolean	Whether has attachment.
Client Viewed Time	invoice.client_viewed_time	string	The client viewed time.
Line Item	invoice.line_items	array of object
ID	invoice.line_items.line_item_id	string	The line item identifier.
ID	invoice.line_items.item_id	string	The item identifier.
Project ID	invoice.line_items.project_id	string	The project identifier.
Project Name	invoice.line_items.project_name	string	The project name.
Item Type	invoice.line_items.item_type	string	The item type.
Product Type	invoice.line_items.product_type	string	The product type.
time_entry_ids	invoice.line_items.time_entry_ids	array of integer	time_entry_ids
Expense ID	invoice.line_items.expense_id	string	The expense identifier.
Expense Receipt Name	invoice.line_items.expense_receipt_name	string	The expense receipt name.
Name	invoice.line_items.name	string	The name.
Description	invoice.line_items.description	string	The description.
Item Order	invoice.line_items.item_order	integer	The item order.
BCY Rate	invoice.line_items.bcy_rate	double	The BCY rate.
Rate	invoice.line_items.rate	double	The rate.
Quantity	invoice.line_items.quantity	double	The quantity.
Unit	invoice.line_items.unit	string	The unit.
Discount Amount	invoice.line_items.discount_amount	double	The discount amount.
Discount	invoice.line_items.discount	double	The discount.
ID	invoice.line_items.tax_id	string	The tax identifier.
TDS Tax ID	invoice.line_items.tds_tax_id	string	The TDS tax identifier.
Name	invoice.line_items.tax_name	string	The tax name.
Tax Type	invoice.line_items.tax_type	string	The tax type.
Tax Percentage	invoice.line_items.tax_percentage	double	The tax percentage.
Item Total	invoice.line_items.item_total	double	The item total.
SAT Item Key Code	invoice.line_items.sat_item_key_code	integer	The SAT item key code.
Unit Key Code	invoice.line_items.unitkey_code	string	The unit key code.
Shipping Charge	invoice.shipping_charge	double	The shipping charge.
Adjustment	invoice.adjustment	double	The adjustment.
Adjustment Description	invoice.adjustment_description	string	The adjustment description.
Subtotal	invoice.sub_total	double	The subtotal.
Tax Total	invoice.tax_total	double	The tax total.
Total	invoice.total	double	The total.
Tax	invoice.taxes	array of object
Name	invoice.taxes.tax_name	string	The tax name.
Amount	invoice.taxes.tax_amount	double	The tax amount.
Payment Reminder Enabled	invoice.payment_reminder_enabled	boolean	Whether payment reminder is enabled.
Payment Made	invoice.payment_made	double	The payment made.
Credits Applied	invoice.credits_applied	double	The credits applied.
Tax Amount Withheld	invoice.tax_amount_withheld	double	The tax amount withheld.
Balance	invoice.balance	double	The balance.
Write Off Amount	invoice.write_off_amount	double	The write off amount.
Allow Partial Payments	invoice.allow_partial_payments	boolean	Whether to allow partial payments.
Price Precision	invoice.price_precision	integer	The price precision.
Gateway	invoice.payment_options.payment_gateways	array of object
Configured	invoice.payment_options.payment_gateways.configured	boolean	Whether configured.
Additional Field	invoice.payment_options.payment_gateways.additional_field1	string	The additional field.
Name	invoice.payment_options.payment_gateways.gateway_name	string	The gateway name.
Is Emailed	invoice.is_emailed	boolean	Whether has been emailed.
Reminders Sent	invoice.reminders_sent	integer	The number of reminders sent.
Last Reminder Sent Date	invoice.last_reminder_sent_date	string	The last reminder sent date.
Address	invoice.billing_address.address	string	The address.
City	invoice.billing_address.city	string	The city.
State	invoice.billing_address.state	string	The state.
Zip	invoice.billing_address.zip	string	The zip code.
Country	invoice.billing_address.country	string	The country.
Fax	invoice.billing_address.fax	string	The fax number.
Address	invoice.shipping_address.address	string	The address.
City	invoice.shipping_address.city	string	The city.
State	invoice.shipping_address.state	string	The state.
Zip	invoice.shipping_address.zip	string	The zip code.
Country	invoice.shipping_address.country	string	The country.
Fax	invoice.shipping_address.fax	string	The fax number.
Notes	invoice.notes	string	The notes.
Terms	invoice.terms	string	The terms.
Custom Field	invoice.custom_fields	array of object
ID	invoice.custom_fields.customfield_id	string	The custom field identifier.
Data Type	invoice.custom_fields.data_type	string	The data type.
Index	invoice.custom_fields.index	integer	The index number.
Label	invoice.custom_fields.label	string	The label.
Show On PDF	invoice.custom_fields.show_on_pdf	boolean	Whether to show on PDF.
Show In All PDFs	invoice.custom_fields.show_in_all_pdf	boolean	Whether to show in all PDFs.
Value	invoice.custom_fields.value	double	The custom field value.
Template ID	invoice.template_id	string	The template identifier.
Template Name	invoice.template_name	string	The template name.
Created Time	invoice.created_time	string	The created time.
Last Modified Time	invoice.last_modified_time	string	The last modified time.
Attachment Name	invoice.attachment_name	string	The attachment name.
Can Send In Mail	invoice.can_send_in_mail	boolean	Whether can send in mail.
Salesperson ID	invoice.salesperson_id	string	The salesperson identifier.
Salesperson Name	invoice.salesperson_name	string	The salesperson's name.
URL	invoice.invoice_url	string	The invoice URL address.