API Docs
/
No Results Found
Recurring Invoices

Recurring Invoices

Recurring Invoices are created in order to send invoice in a predefined time interval.

Possible error codes:
Error CodeMessage
1002Recurring Invoice does not exist
4031Please enter a name for this Recurring Invoice

Attribute

recurring_invoice_id
string
Unique ID of the recurring invoice generated by the server.
recurrence_name
string
Unique name for the recurring profile given by the user. Maximum length [100]
reference_number
string
The Order number of the Recurring Invoice.
is_pre_gst
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
Applicable for transactions that fall before july 1, 2017
gst_no
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
15 digit GST identification number of the customer.
gst_treatment
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are business_gst , business_none , overseas , consumer .
vat_treatment
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
only
(Optional) VAT treatment for the invoices. VAT treatment denotes the location of the customer, if the customer resides in UK then the VAT treatment is uk. If the customer is in an EU country & VAT registered, you are resides in Northen Ireland and selling Goods then his VAT treatment is eu_vat_registered, if he resides outside of the UK then his VAT treatment is overseas (For Pre Brexit, this can be split as eu_vat_registered, eu_vat_not_registered and non_eu).
place_of_supply
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
Place where the goods/services are supplied to. (If not given, place of contact given for the contact will be taken)
customer_name
string
Name of the customer to whom the recurring invoice is raised.
customer_id
string
Customer ID of the customer for whom the recurring invoice is raised.
currency_id
string
The currenct id of the currency
currency_code
string
The currency code in which the invoice is created.
start_date
string
The date on which the recurring invoice starts.
end_date
string
The date on which the recurring invoice expires.
last_sent_date
string
The date at which the last invoice was sent.
next_invoice_date
string
The date at which next invoice is to be sent.
line_items
array
Line items of an invoice.
Show Sub-Attributes arrow
line_item_id
string
The line item id
quantity
int32
Quantity of the item included.
name
string
The name of the line item. Maximum length [100]
item_total
double
Total rate raised by this item. This would be the multiplicative product of item price and quantity.
sku
string
Enter item's SKU information
product_type
string
Enter goods/services
project_id
string
ID of the project
project_name
string
Name of the project.
billing_address
object
The address to which the Item has to be billed.
Show Sub-Attributes arrow
address
string
Billing address for the invoice
street2
string
city
string
City of the customerโ€™s billing address.
state
string
State of the customerโ€™s billing address.
zip
string
Zip code of the customerโ€™s billing address.
country
string
Country of the customerโ€™s billing address.
fax
string
Customer's fax number.
shipping_address
object
The address to which the Item has to be shipped.
Show Sub-Attributes arrow
address
string
Shipping address for the invoice
city
string
City of the customerโ€™s shipping address.
state
string
State of the customerโ€™s shipping address.
zip
string
Zip code of the customerโ€™s shipping address.
country
string
Country of the customerโ€™s shipping address.
fax
string
Customer's fax number.
payment_gateways
array
Show Sub-Attributes arrow
configured
boolean
Boolean check to see if a payment gateway ahs been configured
additional_field1
string
Paypal payment method. Allowed Values: standard and adaptive
gateway_name
string
Name of the payment gateway associated with the invoice. E.g. paypal, stripe.Allowed Values: paypal, authorize_net, payflow_pro, stripe, 2checkout and braintree
payment_options
object
Boolean check to see if a payment gateway ahs been configured
Show Sub-Attributes arrow
configured
boolean
Boolean check to see if a payment gateway ahs been configured
additional_field1
string
Paypal payment method. Allowed Values: standard and adaptive
gateway_name
string
Name of the payment gateway associated with the invoice. E.g. paypal, stripe.Allowed Values: paypal, authorize_net, payflow_pro, stripe, 2checkout and braintree
avatax_exempt_no
string
Avalara Integration only
Exemption certificate number of the customer. Maximum length [25]
avatax_use_code
string
Avalara Integration only
Used to group like customers for exemption purposes. It is a custom value that links customers to a tax rule. Select from Avalara [standard codes][1] or enter a custom code. Maximum length [25]

Example

{ "recurring_invoice_id": "90300000072369", "recurrence_name": "MonthlyInvoice", "reference_number": "12314", "is_pre_gst": false, "gst_no": "22AAAAA0000A1Z5", "gst_treatment": "business_gst", "vat_treatment": "overseas", "place_of_supply": "TN", "customer_name": "David Sujin", "customer_id": "903000000000099", "currency_id": "982000000000190", "currency_code": "USD", "start_date": "2016-06-12", "end_date": "2017-10-12", "last_sent_date": "2016-07-12", "next_invoice_date": "2016-08-17", "line_items": [ { "line_item_id": "982000000567021", "quantity": 1, "name": "Hard Drive", "item_total": 100, "sku": "LEV-JN-SL-36-GN", "product_type": "goods", "project_id": 90300000087378, "project_name": "Sample Project" } ], "billing_address": { "address": "4900 Hopyard Rd, Suite 310", "street2": "McMillan Avenue", "city": "Pleasanton", "state": "CA", "zip": "94588", "country": "U.S.A", "fax": "+1-925-924-9600" }, "shipping_address": { "address": "4900 Hopyard Rd, Suite 310", "city": "Pleasanton", "state": "CA", "zip": "94588", "country": "U.S.A", "fax": "+1-925-924-9600" }, "payment_gateways": [ { "configured": true, "additional_field1": "standard", "gateway_name": "paypal" } ], "payment_options": true, "avatax_exempt_no": "string", "avatax_use_code": "string" }

Create a Recurring Invoice

Creating a new recurring invoice.
oauthscope : ZohoInvoice.invoices.CREATE

Arguments

recurrence_name
string
(Required)
Unique name for the recurring profile given by the user. Maximum length [100]
reference_number
string
The Order number of the Recurring Invoice.
customer_id
string
(Required)
Customer ID of the customer for whom the recurring invoice is raised.
contact_persons
array
Contact Persons associated with the recurring invoice.
start_date
string
The date on which the recurring invoice starts.
end_date
string
The date on which the recurring invoice expires.
place_of_supply
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
Place where the goods/services are supplied to. (If not given, place of contact given for the contact will be taken)
vat_treatment
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
only
(Optional) VAT treatment for the invoices. VAT treatment denotes the location of the customer, if the customer resides in UK then the VAT treatment is uk. If the customer is in an EU country & VAT registered, you are resides in Northen Ireland and selling Goods then his VAT treatment is eu_vat_registered, if he resides outside of the UK then his VAT treatment is overseas (For Pre Brexit, this can be split as eu_vat_registered, eu_vat_not_registered and non_eu).
gst_treatment
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are business_gst , business_none , overseas , consumer .
gst_no
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
15 digit GST identification number of the customer.
recurrence_frequency
string
(Required)
The frequency of time interval at which the invoice is to be generated.
repeat_every
integer
The period between every recurrency frequency.
line_items
array
Line items of an invoice.
Show Sub-Attributes arrow
item_id
string
Unique string generated for the item for which invoice is to be sent.
name
string
The name of the line item. Maximum length [100]
description
string
A small description about the item. Maximum length [2000]
rate
double
The amount of the item
quantity
int32
Quantity of the item included.
discount
string
The discount given for an item.
tax_id
string
Unique to denote the tax associate to the recurring invoice.
tax_exemption_id
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
, ๐Ÿ‡บ๐Ÿ‡ธ United States
, ๐Ÿ‡จ๐Ÿ‡ฆ Canada
only
Unique ID of the tax exemption.
avatax_tax_code
string
Avalara Integration only
A tax code is a unique label used to group Items (products, services, or charges) together. Maximum length [25]
avatax_use_code
string
Avalara Integration only
Used to group like customers for exemption purposes. It is a custom value that links customers to a tax rule. Select from Avalara [standard codes][1] or enter a custom code. Maximum length [25]
item_total
double
Total rate raised by this item. This would be the multiplicative product of item price and quantity.
product_type
string
Enter goods/services
hsn_or_sac
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
Add HSN/SAC code for your goods/services
project_id
string
ID of the project
tax_id
string
Unique to denote the tax associate to the recurring invoice.
email
string
Email address of the customer.
payment_gateways
array
Show Sub-Attributes arrow
configured
boolean
Boolean check to see if a payment gateway ahs been configured
additional_field1
string
Paypal payment method. Allowed Values: standard and adaptive
gateway_name
string
Name of the payment gateway associated with the invoice. E.g. paypal, stripe.Allowed Values: paypal, authorize_net, payflow_pro, stripe, 2checkout and braintree
tax_authority_id
string
๐Ÿ‡บ๐Ÿ‡ธ United States
, ๐Ÿ‡จ๐Ÿ‡ฆ Canada
only
Unique ID of the tax authority. Tax authority depends on the location of the customer. For example, if the customer is located in NY, then the tax authority is NY tax authority.
tax_exemption_id
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
, ๐Ÿ‡บ๐Ÿ‡ธ United States
, ๐Ÿ‡จ๐Ÿ‡ฆ Canada
only
Unique ID of the tax exemption.
avatax_use_code
string
Avalara Integration only
Used to group like customers for exemption purposes. It is a custom value that links customers to a tax rule. Select from Avalara [standard codes][1] or enter a custom code. Maximum length [25]
avatax_exempt_no
string
Avalara Integration only
Exemption certificate number of the customer. Maximum length [25]

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/recurringinvoices -X POST -H "X-com-zoho-invoice-organizationid: 10234695" -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f" -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "recurrence_name": "MonthlyInvoice", "reference_number": "12314", "customer_id": "903000000000099", "contact_persons": [ "903000006532" ], "start_date": "2016-06-12", "end_date": "2017-10-12", "place_of_supply": "TN", "vat_treatment": "overseas", "gst_treatment": "business_gst", "gst_no": "22AAAAA0000A1Z5", "recurrence_frequency": "weeks", "repeat_every": 2, "line_items": [ { "item_id": "90300000081501", "name": "Hard Drive", "description": "10 GB Space, 300 GB Transfer 100 Email Accounts 10 MySQL Databases", "rate": 100, "quantity": 1, "discount": 10, "tax_id": "903000000000356", "tax_exemption_id": "903000006345", "avatax_tax_code": "string", "avatax_use_code": "string", "item_total": 100, "product_type": "goods", "hsn_or_sac": 80540, "project_id": 90300000087378 } ], "tax_id": "903000000000356", "email": "test@zylker.org", "payment_gateways": [ { "configured": true, "additional_field1": "standard", "gateway_name": "paypal" } ], "tax_authority_id": "903000006345", "tax_exemption_id": "903000006345", "avatax_use_code": "string", "avatax_exempt_no": "string" }

Response Example

{ "code": 0, "message": "The recurring invoice has been created.", "recurring_invoice": { "recurring_invoice_id": "90300000072369", "recurrence_name": "MonthlyInvoice", "reference_number": "12314", "is_pre_gst": false, "gst_no": "22AAAAA0000A1Z5", "gst_treatment": "business_gst", "vat_treatment": "overseas", "place_of_supply": "TN", "customer_name": "David Sujin", "customer_id": "903000000000099", "currency_id": "982000000000190", "currency_code": "USD", "start_date": "2016-06-12", "end_date": "2017-10-12", "last_sent_date": "2016-07-12", "next_invoice_date": "2016-08-17", "line_items": [ { "line_item_id": "982000000567021", "quantity": 1, "name": "Hard Drive", "item_total": 100, "sku": "LEV-JN-SL-36-GN", "product_type": "goods", "project_id": 90300000087378, "project_name": "Sample Project" } ], "billing_address": { "address": "4900 Hopyard Rd, Suite 310", "street2": "McMillan Avenue", "city": "Pleasanton", "state": "CA", "zip": "94588", "country": "U.S.A", "fax": "+1-925-924-9600" }, "shipping_address": { "address": "4900 Hopyard Rd, Suite 310", "city": "Pleasanton", "state": "CA", "zip": "94588", "country": "U.S.A", "fax": "+1-925-924-9600" }, "payment_gateways": [ { "configured": true, "additional_field1": "standard", "gateway_name": "paypal" } ], "payment_options": true, "avatax_exempt_no": "string", "avatax_use_code": "string" } }

List Recurring Invoice

List the details of all recurring invoice.
oauthscope : ZohoInvoice.invoices.READ

Query Parameters

filter_by
Filter Recurring invoices by any status or payment expected date.Allowed Values: Status.All, Status.Active, Status.Stopped, Status.Expired
search_text
Search invoices by invoice number or purchase order or customer name.Maximum length [100]
sort_column
Sort based on column value

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/recurringinvoices -H "X-com-zoho-invoice-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "Details of a recurring invoice is displayed successfully.", "recurring_invoices": [ { "recurring_invoice_id": "90300000072369", "recurrence_name": "MonthlyInvoice", "customer_name": "David Sujin", "customer_id": "903000000000099", "currency_id": "982000000000190", "currency_code": "USD", "start_date": "2016-06-12", "end_date": "2017-10-12", "last_sent_date": "2016-07-12", "next_invoice_date": "2016-08-17", "line_items": [ { "line_item_id": "982000000567021", "quantity": 1, "name": "Hard Drive", "item_total": 100, "project_id": 90300000087378 } ], "billing_address": { "address": "4900 Hopyard Rd, Suite 310", "street2": "McMillan Avenue", "city": "Pleasanton", "state": "CA", "zip": "94588", "country": "U.S.A", "fax": "+1-925-924-9600" }, "shipping_address": { "address": "4900 Hopyard Rd, Suite 310", "city": "Pleasanton", "state": "CA", "zip": "94588", "country": "U.S.A", "fax": "+1-925-924-9600" }, "payment_gateways": [ { "configured": true, "additional_field1": "standard", "gateway_name": "paypal" } ], "payment_options": true }, {...}, {...} ] }

Update Recurring Invoice

Update the recurring invoice.
oauthscope : ZohoInvoice.invoices.UPDATE

Arguments

recurrence_name
string
(Required)
Unique name for the recurring profile given by the user. Maximum length [100]
reference_number
string
The Order number of the Recurring Invoice.
customer_id
string
(Required)
Customer ID of the customer for whom the recurring invoice is raised.
contact_persons
array
Contact Persons associated with the recurring invoice.
start_date
string
The date on which the recurring invoice starts.
end_date
string
The date on which the recurring invoice expires.
place_of_supply
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
Place where the goods/services are supplied to. (If not given, place of contact given for the contact will be taken)
vat_treatment
string
๐Ÿ‡ฌ๐Ÿ‡ง United Kingdom
only
(Optional) VAT treatment for the invoices. VAT treatment denotes the location of the customer, if the customer resides in UK then the VAT treatment is uk. If the customer is in an EU country & VAT registered, you are resides in Northen Ireland and selling Goods then his VAT treatment is eu_vat_registered, if he resides outside of the UK then his VAT treatment is overseas (For Pre Brexit, this can be split as eu_vat_registered, eu_vat_not_registered and non_eu).
gst_treatment
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are business_gst , business_none , overseas , consumer .
gst_no
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
15 digit GST identification number of the customer.
recurrence_frequency
string
(Required)
The frequency of time interval at which the invoice is to be generated.
repeat_every
integer
The period between every recurrency frequency.
line_items
array
Line items of an invoice.
Show Sub-Attributes arrow
item_id
string
Unique string generated for the item for which invoice is to be sent.
name
string
The name of the line item. Maximum length [100]
description
string
A small description about the item. Maximum length [2000]
rate
double
The amount of the item
quantity
int32
Quantity of the item included.
discount
string
The discount given for an item.
tax_id
string
Unique to denote the tax associate to the recurring invoice.
tax_exemption_id
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
, ๐Ÿ‡บ๐Ÿ‡ธ United States
, ๐Ÿ‡จ๐Ÿ‡ฆ Canada
only
Unique ID of the tax exemption.
avatax_tax_code
string
Avalara Integration only
A tax code is a unique label used to group Items (products, services, or charges) together. Maximum length [25]
avatax_use_code
string
Avalara Integration only
Used to group like customers for exemption purposes. It is a custom value that links customers to a tax rule. Select from Avalara [standard codes][1] or enter a custom code. Maximum length [25]
item_total
double
Total rate raised by this item. This would be the multiplicative product of item price and quantity.
product_type
string
Enter goods/services
hsn_or_sac
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
only
Add HSN/SAC code for your goods/services
project_id
string
ID of the project
tax_id
string
Unique to denote the tax associate to the recurring invoice.
email
string
Email address of the customer.
payment_gateways
array
Show Sub-Attributes arrow
configured
boolean
Boolean check to see if a payment gateway ahs been configured
additional_field1
string
Paypal payment method. Allowed Values: standard and adaptive
gateway_name
string
Name of the payment gateway associated with the invoice. E.g. paypal, stripe.Allowed Values: paypal, authorize_net, payflow_pro, stripe, 2checkout and braintree
tax_authority_id
string
๐Ÿ‡บ๐Ÿ‡ธ United States
, ๐Ÿ‡จ๐Ÿ‡ฆ Canada
only
Unique ID of the tax authority. Tax authority depends on the location of the customer. For example, if the customer is located in NY, then the tax authority is NY tax authority.
tax_exemption_id
string
๐Ÿ‡ฎ๐Ÿ‡ณ India
, ๐Ÿ‡บ๐Ÿ‡ธ United States
, ๐Ÿ‡จ๐Ÿ‡ฆ Canada
only
Unique ID of the tax exemption.
avatax_use_code
string
Avalara Integration only
Used to group like customers for exemption purposes. It is a custom value that links customers to a tax rule. Select from Avalara [standard codes][1] or enter a custom code. Maximum length [25]
avatax_exempt_no
string
Avalara Integration only
Exemption certificate number of the customer. Maximum length [25]

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/recurringinvoices/{recurring_invoice_id} -X PUT -H "X-com-zoho-invoice-organizationid: 10234695" -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f" -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "recurrence_name": "MonthlyInvoice", "reference_number": "12314", "customer_id": "903000000000099", "contact_persons": [ "903000006532" ], "start_date": "2016-06-12", "end_date": "2017-10-12", "place_of_supply": "TN", "vat_treatment": "overseas", "gst_treatment": "business_gst", "gst_no": "22AAAAA0000A1Z5", "recurrence_frequency": "weeks", "repeat_every": 2, "line_items": [ { "item_id": "90300000081501", "name": "Hard Drive", "description": "10 GB Space, 300 GB Transfer 100 Email Accounts 10 MySQL Databases", "rate": 100, "quantity": 1, "discount": 10, "tax_id": "903000000000356", "tax_exemption_id": "903000006345", "avatax_tax_code": "string", "avatax_use_code": "string", "item_total": 100, "product_type": "goods", "hsn_or_sac": 80540, "project_id": 90300000087378 } ], "tax_id": "903000000000356", "email": "test@zylker.org", "payment_gateways": [ { "configured": true, "additional_field1": "standard", "gateway_name": "paypal" } ], "tax_authority_id": "903000006345", "tax_exemption_id": "903000006345", "avatax_use_code": "string", "avatax_exempt_no": "string" }

Response Example

{ "code": 0, "message": "success", "recurring_invoice": { "recurring_invoice_id": "90300000072369", "recurrence_name": "MonthlyInvoice", "reference_number": "12314", "is_pre_gst": false, "gst_no": "22AAAAA0000A1Z5", "gst_treatment": "business_gst", "vat_treatment": "overseas", "place_of_supply": "TN", "customer_name": "David Sujin", "customer_id": "903000000000099", "currency_id": "982000000000190", "currency_code": "USD", "start_date": "2016-06-12", "end_date": "2017-10-12", "last_sent_date": "2016-07-12", "next_invoice_date": "2016-08-17", "line_items": [ { "line_item_id": "982000000567021", "quantity": 1, "name": "Hard Drive", "item_total": 100, "sku": "LEV-JN-SL-36-GN", "product_type": "goods", "project_id": 90300000087378, "project_name": "Sample Project" } ], "billing_address": { "address": "4900 Hopyard Rd, Suite 310", "street2": "McMillan Avenue", "city": "Pleasanton", "state": "CA", "zip": "94588", "country": "U.S.A", "fax": "+1-925-924-9600" }, "shipping_address": { "address": "4900 Hopyard Rd, Suite 310", "city": "Pleasanton", "state": "CA", "zip": "94588", "country": "U.S.A", "fax": "+1-925-924-9600" }, "payment_gateways": [ { "configured": true, "additional_field1": "standard", "gateway_name": "paypal" } ], "payment_options": true, "avatax_exempt_no": "string", "avatax_use_code": "string" } }

Get a Recurring Invoice

Get the details of a recurring invoice.
oauthscope : ZohoInvoice.invoices.READ

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/recurringinvoices/{recurring_invoice_id} -H "X-com-zoho-invoice-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "Details of a recurring invoice is displayed successfully.", "recurring_invoice": { "recurring_invoice_id": "90300000072369", "recurrence_name": "MonthlyInvoice", "reference_number": "12314", "customer_name": "David Sujin", "customer_id": "903000000000099", "is_pre_gst": false, "gst_no": "22AAAAA0000A1Z5", "gst_treatment": "business_gst", "vat_treatment": "overseas", "place_of_supply": "TN", "company_name": "ABC Studios", "customer_email": "test@zylker.org", "customer_mobile_phone": 1234, "customer_phone": 1234, "photo_url": "https://secure.gravatar.com/avatar/xxxxxxxxxx?&d=mm", "currency_id": "982000000000190", "currency_code": "USD", "start_date": "2016-06-12", "end_date": "2017-10-12", "last_sent_date": "2016-07-12", "next_invoice_date": "2016-08-17", "line_items": [ { "line_item_id": "982000000567021", "quantity": 1, "name": "Hard Drive", "item_total": 100, "sku": "LEV-JN-SL-36-GN", "product_type": "goods", "project_id": 90300000087378, "project_name": "Sample Project" } ], "paid_invoices_total": 100, "unpaid_invoices_balance": 100, "billing_address": { "address": "4900 Hopyard Rd, Suite 310", "street2": "McMillan Avenue", "city": "Pleasanton", "state": "CA", "zip": "94588", "country": "U.S.A", "fax": "+1-925-924-9600" }, "shipping_address": { "address": "4900 Hopyard Rd, Suite 310", "city": "Pleasanton", "state": "CA", "zip": "94588", "country": "U.S.A", "fax": "+1-925-924-9600" }, "payment_gateways": [ { "configured": true, "additional_field1": "standard", "gateway_name": "paypal" } ], "payment_options": true } }

Delete a Recurring Invoice

Delete an existing recurring invoice.
oauthscope : ZohoInvoice.invoices.DELETE

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/recurringinvoices/{recurring_invoice_id} -X DELETE -H "X-com-zoho-invoice-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "The recurring invoice is deleted successfully." }

Stop a Recurring Invoice

Stop an active recurring invoice.
oauthscope : ZohoInvoice.invoices.CREATE

Arguments

recurring_invoice_id
string
Unique ID of the recurring invoice generated by the server.

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/recurringinvoices/{recurring_invoice_id}/status/stop -X POST -H "X-com-zoho-invoice-organizationid: 10234695" -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f" -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "recurring_invoice_id": "90300000072369" }

Response Example

{ "code": 0, "message": "The recurring invoice has been stopped." }

Resume a Recurring Invoice

Resume a stopped recurring invoice.
oauthscope : ZohoInvoice.invoices.CREATE

Arguments

recurring_invoice_id
string
Unique ID of the recurring invoice generated by the server.

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/recurringinvoices/{recurring_invoice_id}/status/resume -X POST -H "X-com-zoho-invoice-organizationid: 10234695" -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f" -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "recurring_invoice_id": "90300000072369" }

Response Example

{ "code": 0, "message": "The recurring invoice has been resumed." }

Update Recurring Invoice template

Update the pdf template associated with the recurring invoice.
oauthscope : ZohoInvoice.invoices.UPDATE

Arguments

recurring_invoice_id
string
Unique ID of the recurring invoice generated by the server.
template_id
string
Unique ID of the recurring invoice template.

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/recurringinvoices/{recurring_invoice_id}/templates/{template_id} -X PUT -H "X-com-zoho-invoice-organizationid: 10234695" -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f" -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "recurring_invoice_id": "90300000072369", "template_id": "90300043563547" }

Response Example

{ "code": 0, "message": "The template of the recurring invoice has been updated." }

List Recurring Invoice History

Get the complete history and comments of a recurring invoice.
oauthscope : ZohoInvoice.invoices.READ

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/recurringinvoices/{recurring_invoice_id}/comments -H "X-com-zoho-invoice-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "The complete history and comments of a recurring invoice are displayed successfully.", "comments": [ { "comment_id": "982000000567019", "recurring_invoice_id": "90300000072369", "comment_description": "Recurring Invoice created", "commented_by_id": "982000000554041", "commented_by": "David Sujin", "comment_type": "system", "operation_type": "Added", "date": "2016-06-05", "date_description": "yesterday", "time": "2:02 AM", "transaction_id": "903000002072369", "transaction_type": "estimate" }, {...}, {...} ] }