Recurring Invoices

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

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

Error Code	Message
1002	Recurring Invoice does not exist
4031	Please enter a name for this Recurring Invoice

Download Recurring Invoices OpenAPI Document

End Points

/recurringinvoices/{recurring_invoice_id}

GET

/recurringinvoices/{recurring_invoice_id}

DELETE

/recurringinvoices/{recurring_invoice_id}

POST

/recurringinvoices/{recurring_invoice_id}/status/stop

POST

/recurringinvoices/{recurring_invoice_id}/status/resume

PUT

/recurringinvoices/{recurring_invoice_id}/templates/{template_id}

GET

/recurringinvoices/{recurring_invoice_id}/comments

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

🇮🇳 only

Applicable for transactions that fall before july 1, 2017

gst_no

string

🇮🇳 only

15 digit GST identification number of the customer.

gst_treatment

string

🇮🇳 only

Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are business_gst , business_none , overseas , consumer .

tax_treatment

string

🇲🇽 only

VAT treatment for the Estimate.Allowed Values:
home_country_mexico,border_region_mexico,non_mexico supported only for MX.

cfdi_usage

string

🇲🇽 only

Choose CFDI Usage. Allowed values:
acquisition_of_merchandise, return_discount_bonus, general_expense, buildings, furniture_office_equipment, transport_equipment, computer_equipmentdye_molds_tools, telephone_communication, satellite_communication, other_machinery_equipment, hospital_expense, medical_expense_disability, funeral_expense, donation, interest_mortage_loans, contribution_sar, medical_expense_insurance_pormium, school_transportation_expense, deposit_saving_account, payment_educational_service, no_tax_effect, payment, payroll.

allow_partial_payments

boolean

🇲🇽 only

Choose false for PPU-Single Payments and true for PPD-Installment Payments

vat_treatment

string

🇬🇧 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

🇮🇳 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.

custom_fields

array

Show Sub-Attributes

value

string

Value of the custom field.

label

string

Label of the custom field.

data_type

string

Data type of the custom field.

line_items

array

Line items of an invoice.

Show Sub-Attributes

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

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

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

List of payment gateways

Show Sub-Attributes

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

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]

{
    "recurring_invoice_id": "90300000072369",
    "recurrence_name": "MonthlyInvoice",
    "reference_number": "12314",
    "is_pre_gst": false,
    "gst_no": "22AAAAA0000A1Z5",
    "gst_treatment": "business_gst",
    "tax_treatment": "vat_registered",
    "cfdi_usage": "acquisition_of_merchandise",
    "allow_partial_payments": true,
    "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",
    "custom_fields": [
        {
            "value": "129890",
            "label": "label",
            "data_type": "text"
        }
    ],
    "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.
OAuth Scope : 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

🇮🇳 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

🇬🇧 only

gst_treatment

string

🇮🇳 only

Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are business_gst , business_none , overseas , consumer .

tax_treatment

string

🇲🇽 only

VAT treatment for the Estimate.Allowed Values:
home_country_mexico,border_region_mexico,non_mexico supported only for MX.

cfdi_usage

string

🇲🇽 only

allow_partial_payments

boolean

🇲🇽 only

Choose false for PPU-Single Payments and true for PPD-Installment Payments

gst_no

string

🇮🇳 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.

custom_fields

array

Show Sub-Attributes

value

string

Value of the custom field.

label

string

Label of the custom field.

data_type

string

Data type of the custom field.

line_items

array

Line items of an invoice.

Show Sub-Attributes

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.

tds_tax_id

string

🇲🇽 only

ID of the TDS tax.

tax_exemption_id

string

🇮🇳 , 🇺🇸 , 🇨🇦 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

🇮🇳 only

Add HSN/SAC code for your goods/services

project_id

string

ID of the project

sat_item_key_code

string

🇲🇽 only

Add SAT Item Key Code for your goods/services. Download the CFDI Catalogs.

unitkey_code

string

🇲🇽 only

Add SAT Unit Key Code for your goods/services. Download the CFDI Catalogs.

tax_id

string

Unique to denote the tax associate to the recurring invoice.

string

Email address of the customer.

payment_gateways

array

Show Sub-Attributes

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

🇺🇸 , 🇨🇦 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

🇮🇳 , 🇺🇸 , 🇨🇦 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]

Headers

X-com-zoho-invoice-organizationid

string

(Required)

ID of the organization

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("X-com-zoho-invoice-organizationid", "10234695");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/invoice/v3/recurringinvoices"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/invoice/v3/recurringinvoices")
  .post(body)
  .addHeader("X-com-zoho-invoice-organizationid", "10234695")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    'X-com-zoho-invoice-organizationid': '10234695',
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/invoice/v3/recurringinvoices', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'X-com-zoho-invoice-organizationid': "10234695",
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("POST", "/invoice/v3/recurringinvoices", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/invoice/v3/recurringinvoices",
  "headers": {
    "X-com-zoho-invoice-organizationid": "10234695",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request POST \
  --url https://www.zohoapis.com/invoice/v3/recurringinvoices \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'X-com-zoho-invoice-organizationid: 10234695' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "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",
    "tax_treatment": "vat_registered",
    "cfdi_usage": "acquisition_of_merchandise",
    "allow_partial_payments": true,
    "gst_no": "22AAAAA0000A1Z5",
    "recurrence_frequency": "weeks",
    "repeat_every": 2,
    "custom_fields": [
        {
            "value": "129890",
            "label": "label",
            "data_type": "text"
        }
    ],
    "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",
            "tds_tax_id": "982000000557012",
            "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,
            "sat_item_key_code": 71121206,
            "unitkey_code": "E48"
        }
    ],
    "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"
}

{
    "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",
        "tax_treatment": "vat_registered",
        "cfdi_usage": "acquisition_of_merchandise",
        "allow_partial_payments": true,
        "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",
        "custom_fields": [
            {
                "value": "129890",
                "label": "label",
                "data_type": "text"
            }
        ],
        "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.
OAuth Scope : ZohoInvoice.invoices.READ

Query Parameters

filter_by

string

Filter Recurring invoices by any status or payment expected date.Allowed Values: Status.All, Status.Active, Status.Stopped, Status.Expired

search_text

string

Search invoices by invoice number or purchase order or customer name.Maximum length [100]

sort_column

string

Sort based on column value

page

integer

Page number to be fetched. Default value is 1.

per_page

integer

Number of records to be fetched per page. Default value is 200.

Headers

X-com-zoho-invoice-organizationid

string

(Required)

ID of the organization

Request Example

headers_data = Map();
headers_data.put("X-com-zoho-invoice-organizationid", "10234695");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/invoice/v3/recurringinvoices"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/invoice/v3/recurringinvoices")
  .get()
  .addHeader("X-com-zoho-invoice-organizationid", "10234695")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    'X-com-zoho-invoice-organizationid': '10234695',
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/invoice/v3/recurringinvoices', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = {
    'X-com-zoho-invoice-organizationid': "10234695",
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
    }

conn.request("GET", "/invoice/v3/recurringinvoices", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/invoice/v3/recurringinvoices",
  "headers": {
    "X-com-zoho-invoice-organizationid": "10234695",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url https://www.zohoapis.com/invoice/v3/recurringinvoices \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'X-com-zoho-invoice-organizationid: 10234695'

{
    "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",
            "custom_fields": [
                {
                    "value": "129890",
                    "label": "label",
                    "data_type": "text"
                }
            ],
            "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.
OAuth Scope : 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

🇮🇳 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

🇬🇧 only

gst_treatment

string

🇮🇳 only

Choose whether the contact is GST registered/unregistered/consumer/overseas. Allowed values are business_gst , business_none , overseas , consumer .

tax_treatment

string

🇲🇽 only

VAT treatment for the Estimate.Allowed Values:
home_country_mexico,border_region_mexico,non_mexico supported only for MX.

cfdi_usage

string

🇲🇽 only

allow_partial_payments

boolean

🇲🇽 only

Choose false for PPU-Single Payments and true for PPD-Installment Payments

gst_no

string

🇮🇳 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.

custom_fields

array

Show Sub-Attributes

value

string

Value of the custom field.

label

string

Label of the custom field.

data_type

string

Data type of the custom field.

line_items

array

Line items of an invoice.

Show Sub-Attributes

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.

tds_tax_id

string

🇲🇽 only

ID of the TDS tax.

tax_exemption_id

string

🇮🇳 , 🇺🇸 , 🇨🇦 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

🇮🇳 only

Add HSN/SAC code for your goods/services

project_id

string

ID of the project

sat_item_key_code

string

🇲🇽 only

Add SAT Item Key Code for your goods/services. Download the CFDI Catalogs.

unitkey_code

string

🇲🇽 only

Add SAT Unit Key Code for your goods/services. Download the CFDI Catalogs.

tax_id

string

Unique to denote the tax associate to the recurring invoice.

string

Email address of the customer.

payment_gateways

array

Show Sub-Attributes

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

🇺🇸 , 🇨🇦 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

🇮🇳 , 🇺🇸 , 🇨🇦 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]

Path Parameters

recurring_invoice_id

string

(Required)

Unique identifier of the recurring invoice.

Headers

X-com-zoho-invoice-organizationid

string

(Required)

ID of the organization

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("X-com-zoho-invoice-organizationid", "10234695");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/invoice/v3/recurringinvoices/90300000072369"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/invoice/v3/recurringinvoices/90300000072369")
  .put(body)
  .addHeader("X-com-zoho-invoice-organizationid", "10234695")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'PUT',
  headers: {
    'X-com-zoho-invoice-organizationid': '10234695',
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/invoice/v3/recurringinvoices/90300000072369', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'X-com-zoho-invoice-organizationid': "10234695",
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("PUT", "/invoice/v3/recurringinvoices/90300000072369", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "PUT",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/invoice/v3/recurringinvoices/90300000072369",
  "headers": {
    "X-com-zoho-invoice-organizationid": "10234695",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request PUT \
  --url https://www.zohoapis.com/invoice/v3/recurringinvoices/90300000072369 \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'X-com-zoho-invoice-organizationid: 10234695' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "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",
    "tax_treatment": "vat_registered",
    "cfdi_usage": "acquisition_of_merchandise",
    "allow_partial_payments": true,
    "gst_no": "22AAAAA0000A1Z5",
    "recurrence_frequency": "weeks",
    "repeat_every": 2,
    "custom_fields": [
        {
            "value": "129890",
            "label": "label",
            "data_type": "text"
        }
    ],
    "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",
            "tds_tax_id": "982000000557012",
            "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,
            "sat_item_key_code": 71121206,
            "unitkey_code": "E48"
        }
    ],
    "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"
}

{
    "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",
        "tax_treatment": "vat_registered",
        "cfdi_usage": "acquisition_of_merchandise",
        "allow_partial_payments": true,
        "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",
        "custom_fields": [
            {
                "value": "129890",
                "label": "label",
                "data_type": "text"
            }
        ],
        "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.
OAuth Scope : ZohoInvoice.invoices.READ

Path Parameters

recurring_invoice_id

string

(Required)

Unique identifier of the recurring invoice.

Headers

X-com-zoho-invoice-organizationid

string

(Required)

ID of the organization

Request Example

headers_data = Map();
headers_data.put("X-com-zoho-invoice-organizationid", "10234695");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/invoice/v3/recurringinvoices/90300000072369"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/invoice/v3/recurringinvoices/90300000072369")
  .get()
  .addHeader("X-com-zoho-invoice-organizationid", "10234695")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    'X-com-zoho-invoice-organizationid': '10234695',
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/invoice/v3/recurringinvoices/90300000072369', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = {
    'X-com-zoho-invoice-organizationid': "10234695",
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
    }

conn.request("GET", "/invoice/v3/recurringinvoices/90300000072369", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/invoice/v3/recurringinvoices/90300000072369",
  "headers": {
    "X-com-zoho-invoice-organizationid": "10234695",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url https://www.zohoapis.com/invoice/v3/recurringinvoices/90300000072369 \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'X-com-zoho-invoice-organizationid: 10234695'

{
    "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",
        "tax_treatment": "vat_registered",
        "cfdi_usage": "acquisition_of_merchandise",
        "allow_partial_payments": true,
        "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",
        "custom_fields": [
            {
                "value": "129890",
                "label": "label",
                "data_type": "text"
            }
        ],
        "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.
OAuth Scope : ZohoInvoice.invoices.DELETE

Path Parameters

recurring_invoice_id

string

(Required)

Unique identifier of the recurring invoice.

Headers

X-com-zoho-invoice-organizationid

string

(Required)

ID of the organization

Request Example

headers_data = Map();
headers_data.put("X-com-zoho-invoice-organizationid", "10234695");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/invoice/v3/recurringinvoices/90300000072369"
type: DELETE
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/invoice/v3/recurringinvoices/90300000072369")
  .delete(null)
  .addHeader("X-com-zoho-invoice-organizationid", "10234695")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'DELETE',
  headers: {
    'X-com-zoho-invoice-organizationid': '10234695',
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/invoice/v3/recurringinvoices/90300000072369', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = {
    'X-com-zoho-invoice-organizationid': "10234695",
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
    }

conn.request("DELETE", "/invoice/v3/recurringinvoices/90300000072369", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "DELETE",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/invoice/v3/recurringinvoices/90300000072369",
  "headers": {
    "X-com-zoho-invoice-organizationid": "10234695",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request DELETE \
  --url https://www.zohoapis.com/invoice/v3/recurringinvoices/90300000072369 \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'X-com-zoho-invoice-organizationid: 10234695'

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

Stop a Recurring Invoice

Stop an active recurring invoice.
OAuth Scope : ZohoInvoice.invoices.CREATE

Arguments

recurring_invoice_id

string

Unique ID of the recurring invoice generated by the server.

Path Parameters

recurring_invoice_id

string

(Required)

Unique identifier of the recurring invoice.

Headers

X-com-zoho-invoice-organizationid

string

(Required)

ID of the organization

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("X-com-zoho-invoice-organizationid", "10234695");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/invoice/v3/recurringinvoices/90300000072369/status/stop"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/invoice/v3/recurringinvoices/90300000072369/status/stop")
  .post(body)
  .addHeader("X-com-zoho-invoice-organizationid", "10234695")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    'X-com-zoho-invoice-organizationid': '10234695',
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/invoice/v3/recurringinvoices/90300000072369/status/stop', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'X-com-zoho-invoice-organizationid': "10234695",
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("POST", "/invoice/v3/recurringinvoices/90300000072369/status/stop", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/invoice/v3/recurringinvoices/90300000072369/status/stop",
  "headers": {
    "X-com-zoho-invoice-organizationid": "10234695",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request POST \
  --url https://www.zohoapis.com/invoice/v3/recurringinvoices/90300000072369/status/stop \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'X-com-zoho-invoice-organizationid: 10234695' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "recurring_invoice_id": "90300000072369"
}

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

Resume a Recurring Invoice

Resume a stopped recurring invoice.
OAuth Scope : ZohoInvoice.invoices.CREATE

Arguments

recurring_invoice_id

string

Unique ID of the recurring invoice generated by the server.

Path Parameters

recurring_invoice_id

string

(Required)

Unique identifier of the recurring invoice.

Headers

X-com-zoho-invoice-organizationid

string

(Required)

ID of the organization

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("X-com-zoho-invoice-organizationid", "10234695");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/invoice/v3/recurringinvoices/90300000072369/status/resume"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/invoice/v3/recurringinvoices/90300000072369/status/resume")
  .post(body)
  .addHeader("X-com-zoho-invoice-organizationid", "10234695")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    'X-com-zoho-invoice-organizationid': '10234695',
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/invoice/v3/recurringinvoices/90300000072369/status/resume', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'X-com-zoho-invoice-organizationid': "10234695",
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("POST", "/invoice/v3/recurringinvoices/90300000072369/status/resume", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/invoice/v3/recurringinvoices/90300000072369/status/resume",
  "headers": {
    "X-com-zoho-invoice-organizationid": "10234695",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request POST \
  --url https://www.zohoapis.com/invoice/v3/recurringinvoices/90300000072369/status/resume \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'X-com-zoho-invoice-organizationid: 10234695' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "recurring_invoice_id": "90300000072369"
}

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

Update Recurring Invoice template

Update the pdf template associated with the recurring invoice.
OAuth Scope : 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.

Path Parameters

recurring_invoice_id

string

(Required)

Unique identifier of the recurring invoice.

template_id

string

(Required)

Unique identifier of the recurring invoice template.

Headers

X-com-zoho-invoice-organizationid

string

(Required)

ID of the organization

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("X-com-zoho-invoice-organizationid", "10234695");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/invoice/v3/recurringinvoices/90300000072369/templates/90300000001336"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/invoice/v3/recurringinvoices/90300000072369/templates/90300000001336")
  .put(body)
  .addHeader("X-com-zoho-invoice-organizationid", "10234695")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'PUT',
  headers: {
    'X-com-zoho-invoice-organizationid': '10234695',
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/invoice/v3/recurringinvoices/90300000072369/templates/90300000001336', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'X-com-zoho-invoice-organizationid': "10234695",
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("PUT", "/invoice/v3/recurringinvoices/90300000072369/templates/90300000001336", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "PUT",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/invoice/v3/recurringinvoices/90300000072369/templates/90300000001336",
  "headers": {
    "X-com-zoho-invoice-organizationid": "10234695",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request PUT \
  --url https://www.zohoapis.com/invoice/v3/recurringinvoices/90300000072369/templates/90300000001336 \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'X-com-zoho-invoice-organizationid: 10234695' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "recurring_invoice_id": "90300000072369",
    "template_id": "90300043563547"
}

{
    "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.
OAuth Scope : ZohoInvoice.invoices.READ

Path Parameters

recurring_invoice_id

string

(Required)

Unique identifier of the recurring invoice.

Headers

X-com-zoho-invoice-organizationid

string

(Required)

ID of the organization

Request Example

headers_data = Map();
headers_data.put("X-com-zoho-invoice-organizationid", "10234695");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/invoice/v3/recurringinvoices/90300000072369/comments"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/invoice/v3/recurringinvoices/90300000072369/comments")
  .get()
  .addHeader("X-com-zoho-invoice-organizationid", "10234695")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    'X-com-zoho-invoice-organizationid': '10234695',
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/invoice/v3/recurringinvoices/90300000072369/comments', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = {
    'X-com-zoho-invoice-organizationid': "10234695",
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
    }

conn.request("GET", "/invoice/v3/recurringinvoices/90300000072369/comments", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/invoice/v3/recurringinvoices/90300000072369/comments",
  "headers": {
    "X-com-zoho-invoice-organizationid": "10234695",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url https://www.zohoapis.com/invoice/v3/recurringinvoices/90300000072369/comments \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'X-com-zoho-invoice-organizationid: 10234695'

{
    "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"
        },
        {...},
        {...}
    ]
}