Recurring Invoices

Recurring invoices are invoices that are created and sent to your customers on a recurring schedule.

Download Recurring Invoices OpenAPI Document

End Points

POST

/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. Max-length [100]

reference_number

string

The Order number of the Recurring Invoice.

customer_name

string

Name of the customer to whom the recurring invoice is raised.

contact_persons_associated

array

Contact Persons associated with the transaction.

Show Sub-Attributes

contact_person_id

long

Unique ID of the Contact Person.

contact_person_name

string

Name of the Contact Person

first_name

string

First Name of the Contact Person.

last_name

string

Last Name of the Contact Person.

contact_person_email

string

Email ID of the Contact Person.

phone

string

Phone Number of the Contact Person.

mobile

string

Mobile Number of the Contact Person.

communication_preference

object

Preferred modes of communication for the contact person at transaction level.

Show Sub-Attributes

is_email_enabled

boolean

Used to check if Email communication preference is enabled for the contact person at transaction level.

is_whatsapp_enabled

boolean

WhatsApp integration only

Used to check if WhatsApp communication preference is enabled for the contact person at transaction level.

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

GCC , 🇲🇽 , 🇰🇪 , 🇿🇦 only

Choose whether the vat treatment for the contact falls under: vat_registered,vat_not_registered,gcc_vat_not_registered,gcc_vat_registered,non_gcc.
dz_vat_registered and dz_vat_not_registered supported only for UAE.
home_country_mexico,border_region_mexico,non_mexico supported only for MX.
For Kenya Edition: vat_registered ,vat_not_registered ,non_kenya(A business that is located outside Kenya).
For SouthAfrica Edition: vat_registered, vat_not_registered, overseas(A business that is located outside SouthAfrica).

is_reverse_charge_applied

boolean

🇿🇦 only

(Required if customer tax treatment is vat_registered)
Used to specify whether the transaction is applicable for Domestic Reverse Charge (DRC) or not.

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.

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

🇮🇳 , GCC only

Place where the goods/services are supplied to. (If not given, place of contact given for the contact will be taken)
Supported codes for UAE emirates are :
Abu Dhabi - AB,
Ajman - AJ,
Dubai - DU,
Fujairah - FU,
Ras al-Khaimah - RA,
Sharjah - SH,
Umm al-Quwain - UM
Supported codes for the GCC countries are :
United Arab Emirates - AE,
Saudi Arabia - SA,
Bahrain - BH,
Kuwait - KW,
Oman - OM,
Qatar - QA.

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.

location_id

string

Location ID

location_name

string

Name of the location

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. max-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 or services .
For SouthAfrica Edition: service, goods, capital_service and capital_goods

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.

location_id

string

Location ID

location_name

string

Name of the location

tags

array

Filter all your reports based on the tag

Show Sub-Attributes

is_tag_mandatory

boolean

Boolean to check if the tag is mandatory

tag_id

string

ID of the reporting tag

tag_name

string

Name of the reporting tag

tag_option_id

string

ID of the reporting tag's option

tag_option_name

string

Name of the reporting tag's option

tax_id

ID of the tax or tax group associated to the recurring invoice.

tax_treatment_code

string

GCC only

Specify reason for using out of scope.
Supported values for UAE are uae_same_tax_group, uae_reimbursed_expense and uae_others.
Supported values for Bahrain are bahrain_same_tax_group, bahrain_transfer_of_concern, bahrain_disbursement, bahrain_head_to_branch_transaction, bahrain_warranty_repair_services and bahrain_others.
Supported values for Saudi Arabia are ksa_pvt_health, ksa_pvt_edu, ksa_reimbursed_expense and ksa_house_sales.

project_id

string

ID of the project

project_name

string

Name of the project.

header_name

string

Name of the item header

header_id

string

ID of the item header

billing_address

object

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

Show Sub-Attributes

address

string

Billing address for the invoice

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.

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.

payment_options

object

Show Sub-Attributes

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

avatax_exempt_no

string

Avalara Integration only

Exemption certificate number of the customer. Max-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. Max-length [25]

{
    "recurring_invoice_id": "90300000072369",
    "recurrence_name": "MonthlyInvoice",
    "reference_number": "12314",
    "customer_name": "Sujin Kumar",
    "contact_persons_associated": [
        {
            "contact_person_id": 982000000567003,
            "contact_person_name": "David",
            "first_name": "David",
            "last_name": "Sujin",
            "contact_person_email": "willsmith@bowmanfurniture.com",
            "phone": "+1-925-921-9201",
            "mobile": "+1-4054439562",
            "communication_preference": {
                "is_email_enabled": true,
                "is_whatsapp_enabled": true
            }
        }
    ],
    "is_pre_gst": false,
    "gst_no": "22AAAAA0000A1Z5",
    "gst_treatment": "business_gst",
    "tax_treatment": "vat_registered",
    "is_reverse_charge_applied": true,
    "cfdi_usage": "acquisition_of_merchandise",
    "vat_treatment": "overseas",
    "place_of_supply": "TN",
    "customer_id": "903000000000099",
    "currency_id": "982000000000190",
    "currency_code": "USD",
    "start_date": "2016-06-12",
    "end_date": "2017-06-12",
    "last_sent_date": "2016-06-12",
    "next_invoice_date": "2016-06-17",
    "location_id": "460000000038080",
    "location_name": "string",
    "line_items": [
        {
            "line_item_id": "982000000567021",
            "quantity": 1,
            "name": "Hard Drive",
            "item_total": 100,
            "sku": "LEV-JN-SL-36-GN",
            "product_type": "goods",
            "sat_item_key_code": 71121206,
            "unitkey_code": "box",
            "location_id": "460000000038080",
            "location_name": "string",
            "tags": [
                {
                    "is_tag_mandatory": false,
                    "tag_id": 982000000009070,
                    "tag_name": "Location",
                    "tag_option_id": 982000000002670,
                    "tag_option_name": "USA"
                }
            ],
            "tax_id": "903000000000356",
            "tax_treatment_code": "uae_others",
            "project_id": 90300000087378,
            "project_name": "Sample Project",
            "header_name": "Electronic devices",
            "header_id": 982000000000670
        }
    ],
    "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"
    },
    "custom_fields": [
        {
            "value": "129890",
            "label": "label",
            "data_type": "text"
        }
    ],
    "payment_options": {
        "payment_gateways": [
            {
                "configured": true,
                "additional_field1": "standard",
                "gateway_name": "paypal"
            }
        ]
    },
    "avatax_exempt_no": "string",
    "avatax_use_code": "string"
}

Create a Recurring Invoice

Creating a new recurring invoice.
OAuth Scope : ZohoBooks.invoices.CREATE

Arguments

recurrence_name

string

(Required)

Unique name for the recurring profile given by the user. Max-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.

currency_id

string

The currenct id of the currency

contact_persons_associated

array

Contact Persons associated with the transaction.

Show Sub-Attributes

contact_person_id

long

Unique ID of the Contact Person.

communication_preference

object

Preferred modes of communication for the contact person at transaction level.

Show Sub-Attributes

is_email_enabled

boolean

Used to check if Email communication preference is enabled for the contact person at transaction level.

is_whatsapp_enabled

boolean

WhatsApp integration only

Used to check if WhatsApp communication preference is enabled for the contact person at transaction level.

place_of_supply

string

🇮🇳 , GCC only

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

GCC , 🇲🇽 , 🇰🇪 , 🇿🇦 only

is_reverse_charge_applied

boolean

🇿🇦 only

(Required if customer tax treatment is vat_registered)
Used to specify whether the transaction is applicable for Domestic Reverse Charge (DRC) or not.

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.

start_date

string

The date on which the recurring invoice starts.

end_date

string

The date on which the recurring invoice expires.

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.

location_id

string

Location ID

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. max-length [100]

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 or services .
For SouthAfrica Edition: service, goods, capital_service and capital_goods

hsn_or_sac

string

🇮🇳 , 🇰🇪 , 🇿🇦 only

Add HSN/SAC code for your goods/services

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.

tags

array

Filter all your reports based on the tag

Show Sub-Attributes

tag_id

string

ID of the reporting tag

tag_option_id

string

ID of the reporting tag's option

location_id

string

Location ID

tax_id

ID of the tax or tax group associated to the recurring invoice.

tds_tax_id

string

🇲🇽 only

ID of the TDS tax or TDS tax group associated to the recurring invoice.

tax_treatment_code

string

GCC only

project_id

string

ID of the project

header_name

string

Name of the item header

tax_id

ID of the tax or tax group associated to the recurring invoice.

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.

string

Email address of the customer.

billing_address

object

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

Show Sub-Attributes

address

string

Billing address for the invoice

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.

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. Max-length [25]

avatax_exempt_no

string

Avalara Integration only

Exemption certificate number of the customer. Max-length [25]

template_id

string

Unique ID of the recurring invoice template.

payment_terms

integer

Payment terms in days. E.g: 15,30,60. Invoice due date will be calculated based on this.

payment_terms_label

string

Used to overridethe default payment terms label. Default value for 15 days is "Next 15 days".

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.

exchange_rate

string

Exchange rate for the currency associated with the customer.

payment_options

object

Show Sub-Attributes

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

discount

string

Discount applied to the invoice. It can be either in % or in amount. E.g: 12.5% or 190.

is_discount_before_tax

boolean

Used to specify how the discount has to applied. Either before or after the calculation of tax.

discount_type

string

How the discount is specified. Allowed values: entity_level and item_level.

is_inclusive_tax

boolean

Not applicable 🇺🇸 , 🇨🇦

Used to specify whether the line item rates are inclusive or exclusive of tax.

item_id

string

Unique string generated for the item for which invoice is to be sent.

name

string

The name of the line item. max-length [100]

description

string

A small description about the item. Max-length [2000]

rate

double

Rate of the line item.

quantity

int32

Quantity of the item included.

unit

string

Unit of the line item. E.g: kgs, Nos.

avatax_tax_code

string

A tax code is a unique label used to group items together.

salesperson_name

string

🇺🇸 , 🇦🇺 , 🇨🇦 only

Name of the sales person

shipping_charge

double

Shipping charges applied to the invoice.

adjustment

double

Adjustments made to the invoice.

adjustment_description

string

Customize the adjustment description. E.g: Rounding off.

Query Parameters

organization_id

string

(Required)

ID of the organization

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/recurringinvoices?organization_id=10234695"
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/books/v3/recurringinvoices?organization_id=10234695")
  .post(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

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

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

fetch('https://www.zohoapis.com/books/v3/recurringinvoices?organization_id=10234695', 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 = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("POST", "/books/v3/recurringinvoices?organization_id=10234695", 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": "/books/v3/recurringinvoices?organization_id=10234695",
  "headers": {
    "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/books/v3/recurringinvoices?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "recurrence_name": "MonthlyInvoice",
    "reference_number": "12314",
    "customer_id": "903000000000099",
    "currency_id": "982000000000190",
    "contact_persons_associated": [
        {
            "contact_person_id": 982000000567003,
            "communication_preference": {
                "is_email_enabled": true,
                "is_whatsapp_enabled": true
            }
        }
    ],
    "place_of_supply": "TN",
    "vat_treatment": "overseas",
    "gst_treatment": "business_gst",
    "tax_treatment": "vat_registered",
    "is_reverse_charge_applied": true,
    "cfdi_usage": "acquisition_of_merchandise",
    "allow_partial_payments": true,
    "gst_no": "22AAAAA0000A1Z5",
    "start_date": "2016-06-12",
    "end_date": "2017-06-12",
    "recurrence_frequency": "weeks",
    "repeat_every": 2,
    "location_id": "460000000038080",
    "line_items": [
        {
            "line_item_id": "982000000567021",
            "quantity": 1,
            "name": "Hard Drive",
            "item_total": 100,
            "product_type": "goods",
            "hsn_or_sac": 80540,
            "sat_item_key_code": 71121206,
            "unitkey_code": "box",
            "tags": [
                {
                    "tag_id": 982000000009070,
                    "tag_option_id": 982000000002670
                }
            ],
            "location_id": "460000000038080",
            "tax_id": "903000000000356",
            "tds_tax_id": "903000000000357",
            "tax_treatment_code": "uae_others",
            "project_id": 90300000087378,
            "header_name": "Electronic devices"
        }
    ],
    "tax_id": "903000000000356",
    "custom_fields": [
        {
            "value": "129890",
            "label": "label",
            "data_type": "text"
        }
    ],
    "email": "benjamin.george@bowmanfurniture.com",
    "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"
    },
    "avatax_use_code": "string",
    "avatax_exempt_no": "string",
    "template_id": "90300000001336",
    "payment_terms": 0,
    "payment_terms_label": "Next 15 days",
    "tax_authority_id": "903000006345",
    "tax_exemption_id": "903000006345",
    "exchange_rate": "5.5",
    "payment_options": {
        "payment_gateways": [
            {
                "configured": true,
                "additional_field1": "standard",
                "gateway_name": "paypal"
            }
        ]
    },
    "discount": "30%",
    "is_discount_before_tax": true,
    "discount_type": "entity level",
    "is_inclusive_tax": false,
    "item_id": "90300000081501",
    "name": "Hard Drive",
    "description": "prorated amount for items",
    "rate": 0,
    "quantity": 1,
    "unit": "kgs",
    "avatax_tax_code": " ",
    "salesperson_name": " ",
    "shipping_charge": 0,
    "adjustment": 0,
    "adjustment_description": "Rounding off"
}

{
    "code": 0,
    "message": "The recurring invoice has been created.",
    "recurring_invoice": {
        "recurring_invoice_id": "90300000072369",
        "recurrence_name": "MonthlyInvoice",
        "reference_number": "12314",
        "customer_name": "Sujin Kumar",
        "contact_persons_associated": [
            {
                "contact_person_id": 982000000567003,
                "contact_person_name": "David",
                "first_name": "David",
                "last_name": "Sujin",
                "contact_person_email": "willsmith@bowmanfurniture.com",
                "phone": "+1-925-921-9201",
                "mobile": "+1-4054439562",
                "communication_preference": {
                    "is_email_enabled": true,
                    "is_whatsapp_enabled": true
                }
            }
        ],
        "is_pre_gst": false,
        "gst_no": "22AAAAA0000A1Z5",
        "gst_treatment": "business_gst",
        "tax_treatment": "vat_registered",
        "is_reverse_charge_applied": true,
        "cfdi_usage": "acquisition_of_merchandise",
        "vat_treatment": "overseas",
        "place_of_supply": "TN",
        "customer_id": "903000000000099",
        "currency_id": "982000000000190",
        "currency_code": "USD",
        "start_date": "2016-06-12",
        "end_date": "2017-06-12",
        "last_sent_date": "2016-06-12",
        "next_invoice_date": "2016-06-17",
        "location_id": "460000000038080",
        "location_name": "string",
        "line_items": [
            {
                "line_item_id": "982000000567021",
                "quantity": 1,
                "name": "Hard Drive",
                "item_total": 100,
                "sku": "LEV-JN-SL-36-GN",
                "product_type": "goods",
                "sat_item_key_code": 71121206,
                "unitkey_code": "box",
                "location_id": "460000000038080",
                "location_name": "string",
                "tags": [
                    {
                        "is_tag_mandatory": false,
                        "tag_id": 982000000009070,
                        "tag_name": "Location",
                        "tag_option_id": 982000000002670,
                        "tag_option_name": "USA"
                    }
                ],
                "tax_id": "903000000000356",
                "tax_treatment_code": "uae_others",
                "project_id": 90300000087378,
                "project_name": "Sample Project",
                "header_name": "Electronic devices",
                "header_id": 982000000000670
            }
        ],
        "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"
        },
        "custom_fields": [
            {
                "value": "129890",
                "label": "label",
                "data_type": "text"
            }
        ],
        "payment_options": {
            "payment_gateways": [
                {
                    "configured": true,
                    "additional_field1": "standard",
                    "gateway_name": "paypal"
                }
            ]
        },
        "avatax_exempt_no": "string",
        "avatax_use_code": "string"
    },
    "page_context": {
        "page": 1,
        "per_page": 200,
        "has_more_page": false,
        "report_name": "Recurring Invoices",
        "applied_filter": "Status.All",
        "sort_column": "created_time",
        "sort_order": "D"
    }
}

Update a recurring invoice using a custom field's unique value

A custom field will have unique values if it's configured to not accept duplicate values. Now, you can use that custom field's value to update a recurring invoice by providing its API name in the X-Unique-Identifier-Key header and its value in the X-Unique-Identifier-Value header. Based on this value, the corresponding recurring invoice will be retrieved and updated. Additionally, there is an optional X-Upsert header. If the X-Upsert header is true and the custom field's unique value is not found in any of the existing recurring invoices, a new recurring invoice will be created if the necessary payload details are available
OAuth Scope : ZohoBooks.invoices.UPDATE

Arguments

recurrence_name

string

(Required)

Unique name for the recurring profile given by the user. Max-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.

currency_id

string

The currenct id of the currency

contact_persons_associated

array

Contact Persons associated with the transaction.

Show Sub-Attributes

contact_person_id

long

Unique ID of the Contact Person.

communication_preference

object

Preferred modes of communication for the contact person at transaction level.

Show Sub-Attributes

is_email_enabled

boolean

Used to check if Email communication preference is enabled for the contact person at transaction level.

is_whatsapp_enabled

boolean

WhatsApp integration only

Used to check if WhatsApp communication preference is enabled for the contact person at transaction level.

start_date

string

The date on which the recurring invoice starts.

end_date

string

The date on which the recurring invoice expires.

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.

place_of_supply

string

🇮🇳 , GCC only

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

GCC , 🇲🇽 , 🇰🇪 , 🇿🇦 only

is_reverse_charge_applied

boolean

🇿🇦 only

(Required if customer tax treatment is vat_registered)
Used to specify whether the transaction is applicable for Domestic Reverse Charge (DRC) or not.

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.

location_id

string

Location ID

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. max-length [100]

description

string

A small description about the item. Max-length [2000]

rate

double

Rate of the line item.

quantity

int32

Quantity of the item included.

discount

string

Discount applied to the invoice. It can be either in % or in amount. E.g: 12.5% or 190.

tags

array

Filter all your reports based on the tag

Show Sub-Attributes

tag_id

string

ID of the reporting tag

tag_option_id

string

ID of the reporting tag's option

tax_id

ID of the tax or tax group associated to the recurring invoice.

tds_tax_id

string

🇲🇽 only

ID of the TDS tax or TDS tax group associated to the recurring invoice.

tax_exemption_id

string

🇮🇳 , 🇺🇸 , 🇦🇺 , 🇨🇦 only

Unique ID of the tax exemption.

tax_treatment_code

string

GCC only

avatax_tax_code

string

A tax code is a unique label used to group items together.

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. Max-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 or services .
For SouthAfrica Edition: service, goods, capital_service and capital_goods

hsn_or_sac

string

🇮🇳 , 🇰🇪 , 🇿🇦 only

Add HSN/SAC code for your goods/services

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.

location_id

string

Location ID

project_id

string

ID of the project

header_name

string

Name of the item header

header_id

string

ID of the item header

string

Email address of the customer.

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.

tax_id

ID of the tax or tax group associated to the recurring invoice.

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.

payment_options

object

Show Sub-Attributes

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_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. Max-length [25]

avatax_exempt_no

string

Avalara Integration only

Exemption certificate number of the customer. Max-length [25]

Query Parameters

organization_id

string

(Required)

ID of the organization

Headers

X-Unique-Identifier-Key

string

(Required)

Unique CustomField Api Name

X-Unique-Identifier-Value

string

(Required)

Unique CustomField Value

X-Upsert

boolean

If there is no record is found unique custom field value , will create new invoice

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("X-Unique-Identifier-Key", "cf_unique_cf");
headers_data.put("X-Unique-Identifier-Value", "unique Value");
headers_data.put("X-Upsert", "true");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/recurringinvoices?organization_id=10234695"
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/books/v3/recurringinvoices?organization_id=10234695")
  .put(body)
  .addHeader("X-Unique-Identifier-Key", "cf_unique_cf")
  .addHeader("X-Unique-Identifier-Value", "unique Value")
  .addHeader("X-Upsert", "true")
  .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-Unique-Identifier-Key': 'cf_unique_cf',
    'X-Unique-Identifier-Value': 'unique Value',
    'X-Upsert': 'true',
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/books/v3/recurringinvoices?organization_id=10234695', 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-Unique-Identifier-Key': "cf_unique_cf",
    'X-Unique-Identifier-Value': "unique Value",
    'X-Upsert': "true",
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("PUT", "/books/v3/recurringinvoices?organization_id=10234695", 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": "/books/v3/recurringinvoices?organization_id=10234695",
  "headers": {
    "X-Unique-Identifier-Key": "cf_unique_cf",
    "X-Unique-Identifier-Value": "unique Value",
    "X-Upsert": "true",
    "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/books/v3/recurringinvoices?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'X-Unique-Identifier-Key: cf_unique_cf' \
  --header 'X-Unique-Identifier-Value: unique Value' \
  --header 'X-Upsert: true' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "recurrence_name": "MonthlyInvoice",
    "reference_number": "12314",
    "customer_id": "903000000000099",
    "currency_id": "982000000000190",
    "contact_persons_associated": [
        {
            "contact_person_id": 982000000567003,
            "communication_preference": {
                "is_email_enabled": true,
                "is_whatsapp_enabled": true
            }
        }
    ],
    "start_date": "2016-06-12",
    "end_date": "2017-06-12",
    "recurrence_frequency": "weeks",
    "repeat_every": 2,
    "place_of_supply": "TN",
    "vat_treatment": "overseas",
    "gst_treatment": "business_gst",
    "tax_treatment": "vat_registered",
    "is_reverse_charge_applied": true,
    "cfdi_usage": "acquisition_of_merchandise",
    "allow_partial_payments": true,
    "gst_no": "22AAAAA0000A1Z5",
    "location_id": "460000000038080",
    "line_items": [
        {
            "item_id": "90300000081501",
            "name": "Hard Drive",
            "description": "prorated amount for items",
            "rate": 0,
            "quantity": 1,
            "discount": "30%",
            "tags": [
                {
                    "tag_id": 982000000009070,
                    "tag_option_id": 982000000002670
                }
            ],
            "tax_id": "903000000000356",
            "tds_tax_id": "903000000000357",
            "tax_exemption_id": "903000006345",
            "tax_treatment_code": "uae_others",
            "avatax_tax_code": " ",
            "avatax_use_code": "string",
            "item_total": 100,
            "product_type": "goods",
            "hsn_or_sac": 80540,
            "sat_item_key_code": 71121206,
            "unitkey_code": "box",
            "location_id": "460000000038080",
            "project_id": 90300000087378,
            "header_name": "Electronic devices",
            "header_id": 982000000000670
        }
    ],
    "email": "benjamin.george@bowmanfurniture.com",
    "custom_fields": [
        {
            "value": "129890",
            "label": "label",
            "data_type": "text"
        }
    ],
    "tax_id": "903000000000356",
    "tax_authority_id": "903000006345",
    "payment_options": {
        "payment_gateways": [
            {
                "configured": true,
                "additional_field1": "standard",
                "gateway_name": "paypal"
            }
        ]
    },
    "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",
        "customer_name": "Sujin Kumar",
        "contact_persons_associated": [
            {
                "contact_person_id": 982000000567003,
                "contact_person_name": "David",
                "first_name": "David",
                "last_name": "Sujin",
                "contact_person_email": "willsmith@bowmanfurniture.com",
                "phone": "+1-925-921-9201",
                "mobile": "+1-4054439562",
                "communication_preference": {
                    "is_email_enabled": true,
                    "is_whatsapp_enabled": true
                }
            }
        ],
        "is_pre_gst": false,
        "gst_no": "22AAAAA0000A1Z5",
        "gst_treatment": "business_gst",
        "is_reverse_charge_applied": true,
        "tax_treatment": "vat_registered",
        "cfdi_usage": "acquisition_of_merchandise",
        "vat_treatment": "overseas",
        "place_of_supply": "TN",
        "customer_id": "903000000000099",
        "currency_id": "982000000000190",
        "currency_code": "USD",
        "start_date": "2016-06-12",
        "end_date": "2017-06-12",
        "last_sent_date": "2016-06-12",
        "next_invoice_date": "2016-06-17",
        "location_id": "460000000038080",
        "location_name": "string",
        "line_items": [
            {
                "line_item_id": "982000000567021",
                "quantity": 1,
                "name": "Hard Drive",
                "item_total": 100,
                "sku": "LEV-JN-SL-36-GN",
                "product_type": "goods",
                "location_id": "460000000038080",
                "location_name": "string",
                "tags": [
                    {
                        "is_tag_mandatory": false,
                        "tag_id": 982000000009070,
                        "tag_name": "Location",
                        "tag_option_id": 982000000002670,
                        "tag_option_name": "USA"
                    }
                ],
                "tax_id": "903000000000356",
                "tax_treatment_code": "uae_others",
                "project_id": 90300000087378,
                "project_name": "Sample Project",
                "header_name": "Electronic devices",
                "header_id": 982000000000670
            }
        ],
        "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_options": {
            "payment_gateways": [
                {
                    "configured": true,
                    "additional_field1": "standard",
                    "gateway_name": "paypal"
                }
            ]
        },
        "avatax_exempt_no": "string",
        "avatax_use_code": "string"
    }
}

List all Recurring Invoice

List the details of all recurring invoice.
OAuth Scope : ZohoBooks.invoices.READ

Query Parameters

organization_id

string

(Required)

ID of the organization

recurrence_name

string

Unique name for the recurring profile given by the user. Max-length [100]

item_name

string

Search recurring invoices by item name. Variants: item_name_startswith and profileitemname_contains.

item_description

string

Search recurring invoices by item description. Variants: item_description_startswith and item_description_contains.

customer_name

string

Name of the customer to whom the recurring invoice is raised.

line_item_id

string

The line item id

item_id

string

Unique string generated for the item for which invoice is to be sent.

tax_id

string

ID of the tax or tax group associated to the recurring invoice.

notes

string

A short note for 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.

customer_id

string

Customer ID of the customer for whom the recurring invoice is raised.

status

string

Status of the recurring invoice. This can be active, stopped or expired.

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. Max-length [100]

sort_column

string

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.

Request Example

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

OkHttpClient client = new OkHttpClient();

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

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

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/books/v3/recurringinvoices?organization_id=10234695', 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 = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/books/v3/recurringinvoices?organization_id=10234695", 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": "/books/v3/recurringinvoices?organization_id=10234695",
  "headers": {
    "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/books/v3/recurringinvoices?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "Details of a recurring invoice is displayed successfully.",
    "recurring_invoices": [
        {
            "recurring_invoice_id": "90300000072369",
            "recurrence_name": "MonthlyInvoice",
            "customer_name": "Sujin Kumar",
            "customer_id": "903000000000099",
            "currency_id": "982000000000190",
            "currency_code": "USD",
            "start_date": "2016-06-12",
            "end_date": "2017-06-12",
            "last_sent_date": "2016-06-12",
            "next_invoice_date": "2016-06-17",
            "custom_fields": [
                {
                    "value": "129890",
                    "label": "label",
                    "data_type": "text"
                }
            ],
            "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"
            }
        },
        {...},
        {...}
    ],
    "page_context": {
        "page": 1,
        "per_page": 200,
        "has_more_page": false,
        "report_name": "Recurring Invoices",
        "applied_filter": "Status.All",
        "sort_column": "created_time",
        "sort_order": "D"
    }
}

Update Recurring Invoice

Update the recurring invoice.
OAuth Scope : ZohoBooks.invoices.UPDATE

Arguments

recurrence_name

string

(Required)

Unique name for the recurring profile given by the user. Max-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.

currency_id

string

The currenct id of the currency

contact_persons_associated

array

Contact Persons associated with the transaction.

Show Sub-Attributes

contact_person_id

long

Unique ID of the Contact Person.

communication_preference

object

Preferred modes of communication for the contact person at transaction level.

Show Sub-Attributes

is_email_enabled

boolean

Used to check if Email communication preference is enabled for the contact person at transaction level.

is_whatsapp_enabled

boolean

WhatsApp integration only

Used to check if WhatsApp communication preference is enabled for the contact person at transaction level.

start_date

string

The date on which the recurring invoice starts.

end_date

string

The date on which the recurring invoice expires.

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.

place_of_supply

string

🇮🇳 , GCC only

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

GCC , 🇲🇽 , 🇰🇪 , 🇿🇦 only

is_reverse_charge_applied

boolean

🇿🇦 only

(Required if customer tax treatment is vat_registered)
Used to specify whether the transaction is applicable for Domestic Reverse Charge (DRC) or not.

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.

location_id

string

Location ID

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. max-length [100]

description

string

A small description about the item. Max-length [2000]

rate

double

Rate of the line item.

quantity

int32

Quantity of the item included.

discount

string

Discount applied to the invoice. It can be either in % or in amount. E.g: 12.5% or 190.

tags

array

Filter all your reports based on the tag

Show Sub-Attributes

tag_id

string

ID of the reporting tag

tag_option_id

string

ID of the reporting tag's option

tax_id

ID of the tax or tax group associated to the recurring invoice.

tds_tax_id

string

🇲🇽 only

ID of the TDS tax or TDS tax group associated to the recurring invoice.

tax_exemption_id

string

🇮🇳 , 🇺🇸 , 🇦🇺 , 🇨🇦 only

Unique ID of the tax exemption.

tax_treatment_code

string

GCC only

avatax_tax_code

string

A tax code is a unique label used to group items together.

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. Max-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 or services .
For SouthAfrica Edition: service, goods, capital_service and capital_goods

hsn_or_sac

string

🇮🇳 , 🇰🇪 , 🇿🇦 only

Add HSN/SAC code for your goods/services

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.

location_id

string

Location ID

project_id

string

ID of the project

header_name

string

Name of the item header

header_id

string

ID of the item header

string

Email address of the customer.

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.

tax_id

ID of the tax or tax group associated to the recurring invoice.

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.

payment_options

object

Show Sub-Attributes

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_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. Max-length [25]

avatax_exempt_no

string

Avalara Integration only

Exemption certificate number of the customer. Max-length [25]

Path Parameters

recurring_invoice_id

string

(Required)

Unique identifier of the recurring invoice.

Query Parameters

organization_id

string

(Required)

ID of the organization

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/recurringinvoices/90300000072369?organization_id=10234695"
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/books/v3/recurringinvoices/90300000072369?organization_id=10234695")
  .put(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

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

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

fetch('https://www.zohoapis.com/books/v3/recurringinvoices/90300000072369?organization_id=10234695', 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 = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("PUT", "/books/v3/recurringinvoices/90300000072369?organization_id=10234695", 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": "/books/v3/recurringinvoices/90300000072369?organization_id=10234695",
  "headers": {
    "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/books/v3/recurringinvoices/90300000072369?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "recurrence_name": "MonthlyInvoice",
    "reference_number": "12314",
    "customer_id": "903000000000099",
    "currency_id": "982000000000190",
    "contact_persons_associated": [
        {
            "contact_person_id": 982000000567003,
            "communication_preference": {
                "is_email_enabled": true,
                "is_whatsapp_enabled": true
            }
        }
    ],
    "start_date": "2016-06-12",
    "end_date": "2017-06-12",
    "recurrence_frequency": "weeks",
    "repeat_every": 2,
    "place_of_supply": "TN",
    "vat_treatment": "overseas",
    "gst_treatment": "business_gst",
    "tax_treatment": "vat_registered",
    "is_reverse_charge_applied": true,
    "cfdi_usage": "acquisition_of_merchandise",
    "allow_partial_payments": true,
    "gst_no": "22AAAAA0000A1Z5",
    "location_id": "460000000038080",
    "line_items": [
        {
            "item_id": "90300000081501",
            "name": "Hard Drive",
            "description": "prorated amount for items",
            "rate": 0,
            "quantity": 1,
            "discount": "30%",
            "tags": [
                {
                    "tag_id": 982000000009070,
                    "tag_option_id": 982000000002670
                }
            ],
            "tax_id": "903000000000356",
            "tds_tax_id": "903000000000357",
            "tax_exemption_id": "903000006345",
            "tax_treatment_code": "uae_others",
            "avatax_tax_code": " ",
            "avatax_use_code": "string",
            "item_total": 100,
            "product_type": "goods",
            "hsn_or_sac": 80540,
            "sat_item_key_code": 71121206,
            "unitkey_code": "box",
            "location_id": "460000000038080",
            "project_id": 90300000087378,
            "header_name": "Electronic devices",
            "header_id": 982000000000670
        }
    ],
    "email": "benjamin.george@bowmanfurniture.com",
    "custom_fields": [
        {
            "value": "129890",
            "label": "label",
            "data_type": "text"
        }
    ],
    "tax_id": "903000000000356",
    "tax_authority_id": "903000006345",
    "payment_options": {
        "payment_gateways": [
            {
                "configured": true,
                "additional_field1": "standard",
                "gateway_name": "paypal"
            }
        ]
    },
    "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",
        "customer_name": "Sujin Kumar",
        "contact_persons_associated": [
            {
                "contact_person_id": 982000000567003,
                "contact_person_name": "David",
                "first_name": "David",
                "last_name": "Sujin",
                "contact_person_email": "willsmith@bowmanfurniture.com",
                "phone": "+1-925-921-9201",
                "mobile": "+1-4054439562",
                "communication_preference": {
                    "is_email_enabled": true,
                    "is_whatsapp_enabled": true
                }
            }
        ],
        "is_pre_gst": false,
        "gst_no": "22AAAAA0000A1Z5",
        "gst_treatment": "business_gst",
        "is_reverse_charge_applied": true,
        "tax_treatment": "vat_registered",
        "cfdi_usage": "acquisition_of_merchandise",
        "vat_treatment": "overseas",
        "place_of_supply": "TN",
        "customer_id": "903000000000099",
        "currency_id": "982000000000190",
        "currency_code": "USD",
        "start_date": "2016-06-12",
        "end_date": "2017-06-12",
        "last_sent_date": "2016-06-12",
        "next_invoice_date": "2016-06-17",
        "location_id": "460000000038080",
        "location_name": "string",
        "line_items": [
            {
                "line_item_id": "982000000567021",
                "quantity": 1,
                "name": "Hard Drive",
                "item_total": 100,
                "sku": "LEV-JN-SL-36-GN",
                "product_type": "goods",
                "location_id": "460000000038080",
                "location_name": "string",
                "tags": [
                    {
                        "is_tag_mandatory": false,
                        "tag_id": 982000000009070,
                        "tag_name": "Location",
                        "tag_option_id": 982000000002670,
                        "tag_option_name": "USA"
                    }
                ],
                "tax_id": "903000000000356",
                "tax_treatment_code": "uae_others",
                "project_id": 90300000087378,
                "project_name": "Sample Project",
                "header_name": "Electronic devices",
                "header_id": 982000000000670
            }
        ],
        "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_options": {
            "payment_gateways": [
                {
                    "configured": true,
                    "additional_field1": "standard",
                    "gateway_name": "paypal"
                }
            ]
        },
        "avatax_exempt_no": "string",
        "avatax_use_code": "string"
    }
}

Get a Recurring Invoice

Get the details of a recurring invoice.
OAuth Scope : ZohoBooks.invoices.READ

Path Parameters

recurring_invoice_id

string

(Required)

Unique identifier of the recurring invoice.

Query Parameters

organization_id

string

(Required)

ID of the organization

Request Example

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

OkHttpClient client = new OkHttpClient();

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

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

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/books/v3/recurringinvoices/90300000072369?organization_id=10234695', 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 = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/books/v3/recurringinvoices/90300000072369?organization_id=10234695", 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": "/books/v3/recurringinvoices/90300000072369?organization_id=10234695",
  "headers": {
    "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/books/v3/recurringinvoices/90300000072369?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "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": "Sujin Kumar",
        "customer_id": "903000000000099",
        "company_name": "ABC Studios",
        "contact_persons_associated": [
            {
                "contact_person_id": 982000000567003,
                "contact_person_name": "David",
                "first_name": "David",
                "last_name": "Sujin",
                "contact_person_email": "willsmith@bowmanfurniture.com",
                "phone": "+1-925-921-9201",
                "mobile": "+1-4054439562",
                "communication_preference": {
                    "is_email_enabled": true,
                    "is_whatsapp_enabled": true
                }
            }
        ],
        "is_pre_gst": false,
        "gst_no": "22AAAAA0000A1Z5",
        "gst_treatment": "business_gst",
        "tax_treatment": "vat_registered",
        "is_reverse_charge_applied": true,
        "cfdi_usage": "acquisition_of_merchandise",
        "vat_treatment": "overseas",
        "place_of_supply": "TN",
        "customer_email": "emailid@abcstudios.com",
        "customer_mobile_phone": 9876543210,
        "customer_phone": "012-12345678",
        "photo_url": "https://secure.gravatar.com/avatar/xxxxxxxxxx?&d=mm",
        "currency_id": "982000000000190",
        "currency_code": "USD",
        "start_date": "2016-06-12",
        "end_date": "2017-06-12",
        "last_sent_date": "2016-06-12",
        "next_invoice_date": "2016-06-17",
        "location_id": "460000000038080",
        "location_name": "string",
        "line_items": [
            {
                "line_item_id": "982000000567021",
                "quantity": 1,
                "name": "Hard Drive",
                "item_total": 100,
                "sku": "LEV-JN-SL-36-GN",
                "product_type": "goods",
                "location_id": "460000000038080",
                "location_name": "string",
                "tags": [
                    {
                        "is_tag_mandatory": false,
                        "tag_id": 982000000009070,
                        "tag_name": "Location",
                        "tag_option_id": 982000000002670,
                        "tag_option_name": "USA"
                    }
                ],
                "tax_id": "903000000000356",
                "tax_treatment_code": "uae_others",
                "project_id": 90300000087378,
                "project_name": "Sample Project",
                "header_name": "Electronic devices",
                "header_id": 982000000000670
            }
        ],
        "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_options": {
            "payment_gateways": [
                {
                    "configured": true,
                    "additional_field1": "standard",
                    "gateway_name": "paypal"
                }
            ]
        }
    },
    "page_context": {
        "page": 1,
        "per_page": 200,
        "has_more_page": false,
        "report_name": "Recurring Invoices",
        "applied_filter": "Status.All",
        "sort_column": "created_time",
        "sort_order": "D"
    }
}

Delete a Recurring Invoice

Delete an existing recurring invoice.
OAuth Scope : ZohoBooks.invoices.DELETE

Path Parameters

recurring_invoice_id

string

(Required)

Unique identifier of the recurring invoice.

Query Parameters

organization_id

string

(Required)

ID of the organization

Request Example

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

OkHttpClient client = new OkHttpClient();

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

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

const options = {
  method: 'DELETE',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/books/v3/recurringinvoices/90300000072369?organization_id=10234695', 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 = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("DELETE", "/books/v3/recurringinvoices/90300000072369?organization_id=10234695", 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": "/books/v3/recurringinvoices/90300000072369?organization_id=10234695",
  "headers": {
    "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/books/v3/recurringinvoices/90300000072369?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

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

Stop a Recurring Invoice

Stop an active recurring invoice.
OAuth Scope : ZohoBooks.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.

Query Parameters

organization_id

string

(Required)

ID of the organization

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/recurringinvoices/90300000072369/status/stop?organization_id=10234695"
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/books/v3/recurringinvoices/90300000072369/status/stop?organization_id=10234695")
  .post(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

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

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

fetch('https://www.zohoapis.com/books/v3/recurringinvoices/90300000072369/status/stop?organization_id=10234695', 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 = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("POST", "/books/v3/recurringinvoices/90300000072369/status/stop?organization_id=10234695", 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": "/books/v3/recurringinvoices/90300000072369/status/stop?organization_id=10234695",
  "headers": {
    "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/books/v3/recurringinvoices/90300000072369/status/stop?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --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 : ZohoBooks.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.

Query Parameters

organization_id

string

(Required)

ID of the organization

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/recurringinvoices/90300000072369/status/resume?organization_id=10234695"
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/books/v3/recurringinvoices/90300000072369/status/resume?organization_id=10234695")
  .post(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

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

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

fetch('https://www.zohoapis.com/books/v3/recurringinvoices/90300000072369/status/resume?organization_id=10234695', 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 = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("POST", "/books/v3/recurringinvoices/90300000072369/status/resume?organization_id=10234695", 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": "/books/v3/recurringinvoices/90300000072369/status/resume?organization_id=10234695",
  "headers": {
    "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/books/v3/recurringinvoices/90300000072369/status/resume?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --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 : ZohoBooks.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.

Query Parameters

organization_id

string

(Required)

ID of the organization

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/books/v3/recurringinvoices/90300000072369/templates/90300000001336?organization_id=10234695"
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/books/v3/recurringinvoices/90300000072369/templates/90300000001336?organization_id=10234695")
  .put(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

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

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

fetch('https://www.zohoapis.com/books/v3/recurringinvoices/90300000072369/templates/90300000001336?organization_id=10234695', 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 = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("PUT", "/books/v3/recurringinvoices/90300000072369/templates/90300000001336?organization_id=10234695", 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": "/books/v3/recurringinvoices/90300000072369/templates/90300000001336?organization_id=10234695",
  "headers": {
    "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/books/v3/recurringinvoices/90300000072369/templates/90300000001336?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --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 : ZohoBooks.invoices.READ

Path Parameters

recurring_invoice_id

string

(Required)

Unique identifier of the recurring invoice.

Query Parameters

organization_id

string

(Required)

ID of the organization

Request Example

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

OkHttpClient client = new OkHttpClient();

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

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

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/books/v3/recurringinvoices/90300000072369/comments?organization_id=10234695', 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 = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/books/v3/recurringinvoices/90300000072369/comments?organization_id=10234695", 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": "/books/v3/recurringinvoices/90300000072369/comments?organization_id=10234695",
  "headers": {
    "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/books/v3/recurringinvoices/90300000072369/comments?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "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": "Sujin Kumar",
            "comment_type": "system",
            "operation_type": "Added",
            "date": "2016-06-05",
            "date_description": "yesterday",
            "time": "2:02 AM",
            "transaction_id": "903000002072369",
            "transaction_type": "estimate"
        },
        {...},
        {...}
    ]
}