Custom Modules

In Zoho Billing, you can create a custom module to record other data when the predefined modules are not sufficient to manage all your business requirements
(Note : cf_ attribute is placeholder of the created custom field)

Download Custom Modules OpenAPI Document

End Points

POST

/settings/modules/{module_api_name}

GET

/settings/modules/{module_api_name}

DELETE

/settings/modules/{module_api_name}

/{module_name}/{module_id}

GET

/{module_name}/{module_id}

DELETE

/{module_name}/{module_id}

Attribute

module_record_id

string

ID of the Custom Module Record

module_api_name

string

Module API Name

last_modified_time

string

Last Modified time of the Sales Order

last_modified_time_formatted

string

Formatted value of modified Time

created_time

string

Creation Time of the Sales Order

created_time_formatted

string

Creation Time of the Sales Order

created_by_id

string

Formatted value of created time

last_modified_by_id

string

Last modified by User ID

record_name

string

Name of the record

record_name_formatted

string

Name of the Record Formatted

cf_debt_amount

number

Value of the custom Field

cf_debt_amount_formatted

string

The formatted value of the custom Field

{
    "module_record_id": "460000000639129",
    "module_api_name": "cm_debtor",
    "last_modified_time": "2022-02-18T11:00:45+0530",
    "last_modified_time_formatted": "18/02/2022 11:00 AM",
    "created_time": "2022-02-18T11:00:45+0530",
    "created_time_formatted": "2022-02-18T11:00:45+0530",
    "created_by_id": "2022-02-18T11:00:45+0530",
    "last_modified_by_id": "2112155000000069001",
    "record_name": "Alice",
    "record_name_formatted": "Alice",
    "cf_debt_amount": 10000,
    "cf_debt_amount_formatted": "₹10,000.00"
}

Create a new custom module configuration. Define the module name, fields, permissions, and other settings.
OAuth Scope : ZohoSubscriptions.settings.CREATE

Arguments

module_name

string

(Required)

Display name of the custom module. Max-length [25]

plural_name

string

(Required)

Plural form of the module name. Max-length [30]

parent_module_id

string

ID of the parent module, if this is a sub-module.

record_name

string

Label for the record name field. Max-length [30]

description

string

Description of the custom module. Max-length [150]

shared_type

string

Sharing type for the module. Allowed Values: private, read_only, read_write and public.

is_reporting_tags_supported

boolean

Whether reporting tags are supported for this module.

can_edit_module

boolean

Whether records in this module can be edited.

can_create_module

boolean

Whether records can be created in this module.

can_delete_module

boolean

Whether records can be deleted from this module.

can_bulk_update_module

boolean

Whether bulk update is supported.

can_send_mail

boolean

Whether sending mail is supported from this module.

can_bulk_send_mail

boolean

Whether bulk mail sending is supported.

can_attach_documents

boolean

Whether document attachment is supported.

can_show_pdf_view

boolean

Whether PDF view is available.

can_allow_pdf_print

boolean

Whether PDF print is allowed.

allow_forclone

boolean

Whether cloning records is allowed.

can_lock_record

boolean

Whether record locking is supported.

can_use_widget_for_custommodule

boolean

Whether widgets can be used in this module.

can_show_custommodule_lhs

boolean

Whether to show the module in the left-hand side navigation.

show_custommodule_in

array

Where to show the custom module. Each item has a show_in value.

Show Sub-Attributes

show_in

string

Allowed Values: settings, webui, extension and lhs.

module_permission

array

Role-based permissions for the module.

Show Sub-Attributes

role_id

string

ID of the role.

can_create

boolean

Permission to create records.

can_edit

boolean

Permission to edit records.

can_view

boolean

Permission to view records.

can_delete

boolean

Permission to delete records.

can_approve

boolean

Permission to approve records.

full_access

boolean

Full access permission.

module_visibility

array

Visibility settings for the module in different contexts.

Show Sub-Attributes

type

string

Context type.

is_hidden

boolean

Whether the module is hidden in this context.

allowed_apps

array

List of apps where this module is available.

default_customview_api_name

string

API name of the default custom view for this module.

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/billing/v1/settings/modules?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/billing/v1/settings/modules?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/billing/v1/settings/modules?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", "/billing/v1/settings/modules?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": "/billing/v1/settings/modules?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/billing/v1/settings/modules?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "module_name": "Debtor",
    "plural_name": "Debtors",
    "parent_module_id": "string",
    "record_name": "Debtor Name",
    "description": "Module to track debtors",
    "shared_type": "private",
    "is_reporting_tags_supported": false,
    "can_edit_module": true,
    "can_create_module": true,
    "can_delete_module": true,
    "can_bulk_update_module": false,
    "can_send_mail": false,
    "can_bulk_send_mail": false,
    "can_attach_documents": true,
    "can_show_pdf_view": false,
    "can_allow_pdf_print": false,
    "allow_forclone": false,
    "can_lock_record": false,
    "can_use_widget_for_custommodule": false,
    "can_show_custommodule_lhs": true,
    "show_custommodule_in": [
        {
            "show_in": "webui"
        }
    ],
    "module_permission": [
        {
            "role_id": "string",
            "can_create": true,
            "can_edit": true,
            "can_view": true,
            "can_delete": true,
            "can_approve": true,
            "full_access": true
        }
    ],
    "module_visibility": [
        {
            "type": "string",
            "is_hidden": true
        }
    ],
    "allowed_apps": [
        "billing"
    ],
    "default_customview_api_name": "string"
}

{
    "code": 0,
    "message": "The custom module has been created.",
    "module": {
        "module_id": "982000000567001",
        "module_name": "Debtors",
        "module_api_name": "cm_debtor",
        "is_active": true,
        "singular_name": "Debtor",
        "plural_name": "Debtors"
    }
}

List all custom module configurations in the organization. This returns the module definitions including field configurations, permissions, and portal settings.
OAuth Scope : ZohoSubscriptions.settings.READ

Query Parameters

organization_id

string

(Required)

ID of the organization

portal_type

string

Filter by portal type. Allowed values: customer, vendor and employee.

sort_order

string

Sort order. Allowed values: ascending and descending.

page

integer

Page number for pagination.

per_page

integer

Number of records per page.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/billing/v1/settings/modules?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/billing/v1/settings/modules?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/billing/v1/settings/modules?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", "/billing/v1/settings/modules?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": "/billing/v1/settings/modules?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/billing/v1/settings/modules?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "success",
    "modules": [
        {
            "module_id": "982000000567001",
            "module_name": "Debtors",
            "module_api_name": "cm_debtor",
            "is_active": true,
            "singular_name": "Debtor",
            "plural_name": "Debtors"
        },
        {...},
        {...}
    ]
}

Update the configuration of an existing custom module.
OAuth Scope : ZohoSubscriptions.settings.UPDATE

Arguments

module_name

string

(Required)

Display name of the custom module. Max-length [25]

plural_name

string

(Required)

Plural form of the module name. Max-length [30]

parent_module_id

string

ID of the parent module, if this is a sub-module.

record_name

string

Label for the record name field. Max-length [30]

description

string

Description of the custom module. Max-length [150]

shared_type

string

Sharing type for the module. Allowed Values: private, read_only, read_write and public.

is_reporting_tags_supported

boolean

Whether reporting tags are supported for this module.

can_edit_module

boolean

Whether records in this module can be edited.

can_bulk_update_module

boolean

Whether bulk update is supported.

can_send_mail

boolean

Whether sending mail is supported from this module.

can_bulk_send_mail

boolean

Whether bulk mail sending is supported.

can_attach_documents

boolean

Whether document attachment is supported.

can_show_pdf_view

boolean

Whether PDF view is available.

can_allow_pdf_print

boolean

Whether PDF print is allowed.

allow_forclone

boolean

Whether cloning records is allowed.

can_lock_record

boolean

Whether record locking is supported.

can_use_widget_for_custommodule

boolean

Whether widgets can be used in this module.

can_show_custommodule_lhs

boolean

Whether to show the module in the left-hand side navigation.

show_custommodule_in

array

Where to show the custom module. Each item has a show_in value.

Show Sub-Attributes

show_in

string

Allowed Values: settings, webui, extension and lhs.

module_permission

array

Role-based permissions for the module.

Show Sub-Attributes

role_id

string

ID of the role.

can_create

boolean

Permission to create records.

can_edit

boolean

Permission to edit records.

can_view

boolean

Permission to view records.

can_delete

boolean

Permission to delete records.

can_approve

boolean

Permission to approve records.

full_access

boolean

Full access permission.

module_visibility

array

Visibility settings for the module in different contexts.

Show Sub-Attributes

type

string

Context type.

is_hidden

boolean

Whether the module is hidden in this context.

default_customview_api_name

string

API name of the default custom view for this module.

Path Parameters

module_api_name

string

(Required)

API name of the custom module (e.g., cm_debtor).

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/billing/v1/settings/modules/cm_debtor?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/billing/v1/settings/modules/cm_debtor?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/billing/v1/settings/modules/cm_debtor?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", "/billing/v1/settings/modules/cm_debtor?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": "/billing/v1/settings/modules/cm_debtor?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/billing/v1/settings/modules/cm_debtor?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "module_name": "Debtor",
    "plural_name": "Debtors",
    "parent_module_id": "string",
    "record_name": "Debtor Name",
    "description": "Module to track debtors",
    "shared_type": "private",
    "is_reporting_tags_supported": false,
    "can_edit_module": true,
    "can_bulk_update_module": false,
    "can_send_mail": false,
    "can_bulk_send_mail": false,
    "can_attach_documents": true,
    "can_show_pdf_view": false,
    "can_allow_pdf_print": false,
    "allow_forclone": false,
    "can_lock_record": false,
    "can_use_widget_for_custommodule": false,
    "can_show_custommodule_lhs": true,
    "show_custommodule_in": [
        {
            "show_in": "webui"
        }
    ],
    "module_permission": [
        {
            "role_id": "string",
            "can_create": true,
            "can_edit": true,
            "can_view": true,
            "can_delete": true,
            "can_approve": true,
            "full_access": true
        }
    ],
    "module_visibility": [
        {
            "type": "string",
            "is_hidden": true
        }
    ],
    "default_customview_api_name": "string"
}

{
    "code": 0,
    "message": "The custom module has been updated.",
    "module": {
        "module_id": "982000000567001",
        "module_name": "Debtors",
        "module_api_name": "cm_debtor",
        "is_active": true,
        "singular_name": "Debtor",
        "plural_name": "Debtors"
    }
}

Get the configuration details of a specific custom module.
OAuth Scope : ZohoSubscriptions.settings.READ

Path Parameters

module_api_name

string

(Required)

API name of the custom module (e.g., cm_debtor).

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/billing/v1/settings/modules/cm_debtor?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/billing/v1/settings/modules/cm_debtor?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/billing/v1/settings/modules/cm_debtor?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", "/billing/v1/settings/modules/cm_debtor?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": "/billing/v1/settings/modules/cm_debtor?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/billing/v1/settings/modules/cm_debtor?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "success",
    "module": {
        "module_id": "982000000567001",
        "module_name": "Debtors",
        "module_api_name": "cm_debtor",
        "is_active": true,
        "singular_name": "Debtor",
        "plural_name": "Debtors"
    }
}

Delete an existing custom module configuration and all its records.
OAuth Scope : ZohoSubscriptions.settings.DELETE

Path Parameters

module_api_name

string

(Required)

API name of the custom module (e.g., cm_debtor).

Query Parameters

organization_id

string

(Required)

ID of the organization

force_delete

boolean

Force delete even if the module has existing records.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/billing/v1/settings/modules/cm_debtor?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/billing/v1/settings/modules/cm_debtor?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/billing/v1/settings/modules/cm_debtor?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", "/billing/v1/settings/modules/cm_debtor?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": "/billing/v1/settings/modules/cm_debtor?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/billing/v1/settings/modules/cm_debtor?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "The custom module has been deleted."
}

Create a new record in a custom module.
OAuth Scope : ZohoSubscriptions.custommodules.ALL

Arguments

record_name

string

(Required)

Name of the record

cf_debt_amount

number

Value of the custom Field

Path Parameters

module_name

string

(Required)

Module Name

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/billing/v1/debtor?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/billing/v1/debtor?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/billing/v1/debtor?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", "/billing/v1/debtor?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": "/billing/v1/debtor?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/billing/v1/debtor?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "record_name": "Alice",
    "cf_debt_amount": 10000
}

{
    "code": 0,
    "message": "debtor is created successfully",
    "module_record": [
        {
            "module_record_id": "460000000639129",
            "module_api_name": "cm_debtor",
            "last_modified_time": "2022-02-18T11:00:45+0530",
            "last_modified_time_formatted": "18/02/2022 11:00 AM",
            "created_time": "2022-02-18T11:00:45+0530",
            "created_time_formatted": "2022-02-18T11:00:45+0530",
            "created_by_id": "2022-02-18T11:00:45+0530",
            "last_modified_by_id": "2112155000000069001",
            "record_name": "Alice",
            "record_name_formatted": "Alice",
            "cf_debt_amount": 10000,
            "cf_debt_amount_formatted": "₹10,000.00"
        },
        {...},
        {...}
    ]
}

Update existing custom module records in bulk.
OAuth Scope : ZohoSubscriptions.custommodules.ALL

Arguments

cf_debt_amount

number

Value of the custom Field

module_record_id

string

Reeccord IDs

record_name

string

(Required)

Name of the record

Path Parameters

module_name

string

(Required)

Module Name

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/billing/v1/debtor?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/billing/v1/debtor?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/billing/v1/debtor?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", "/billing/v1/debtor?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": "/billing/v1/debtor?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/billing/v1/debtor?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "cf_debt_amount": 10000,
    "module_record_id": "460000000639128,460000000639129",
    "record_name": "Alice"
}

{
    "code": 0,
    "message": "Bulk update successfull",
    "module_record": [
        {
            "module_record_id": "460000000639129",
            "module_api_name": "cm_debtor",
            "last_modified_time": "2022-02-18T11:00:45+0530",
            "last_modified_time_formatted": "18/02/2022 11:00 AM",
            "created_time": "2022-02-18T11:00:45+0530",
            "created_time_formatted": "2022-02-18T11:00:45+0530",
            "created_by_id": "2022-02-18T11:00:45+0530",
            "last_modified_by_id": "2112155000000069001",
            "record_name": "Alice",
            "record_name_formatted": "Alice",
            "cf_debt_amount": 10000,
            "cf_debt_amount_formatted": "₹10,000.00",
            "code": 0,
            "message": "success"
        },
        {...},
        {...}
    ]
}

Get the list of records of a custom module.
OAuth Scope : ZohoSubscriptions.custommodules.ALL

Path Parameters

module_name

string

(Required)

Module Name

Query Parameters

organization_id

string

(Required)

ID of the organization

customview_id

string

Filter records based on a custom view.

filter_by

string

Filter records by status. Allowed Values: Status.All, Status.Active, Status.Inactive

search_text

string

Search records by text.

sort_column

string

Sort records by column. Allowed Values: record_name, created_time, last_modified_time or any custom field API name (cf_*).

sort_order

string

Sort order. Allowed Values: A (Ascending), D (Descending)

page

integer

Page number for pagination.

per_page

integer

Number of records per page.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/billing/v1/debtor?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/billing/v1/debtor?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/billing/v1/debtor?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", "/billing/v1/debtor?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": "/billing/v1/debtor?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/billing/v1/debtor?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "success",
    "module_record": [
        {
            "module_record_id": "460000000639129",
            "module_api_name": "cm_debtor",
            "last_modified_time": "2022-02-18T11:00:45+0530",
            "last_modified_time_formatted": "18/02/2022 11:00 AM",
            "created_time": "2022-02-18T11:00:45+0530",
            "created_time_formatted": "2022-02-18T11:00:45+0530",
            "created_by_id": "2022-02-18T11:00:45+0530",
            "last_modified_by_id": "2112155000000069001",
            "record_name": "Alice",
            "record_name_formatted": "Alice",
            "cf_debt_amount": 10000,
            "cf_debt_amount_formatted": "₹10,000.00"
        },
        {...},
        {...}
    ],
    "page_context": {
        "page": 1,
        "per_page": 200,
        "has_more_page": false,
        "applied_filter": "Status.All",
        "sort_column": "created_time",
        "sort_order": "D"
    }
}

Delete records from a custom module.
OAuth Scope : ZohoSubscriptions.custommodules.ALL

Path Parameters

module_name

string

(Required)

Module Name

Query Parameters

organization_id

string

(Required)

ID of the organization

record_ids

string

Comma-separated list of record IDs to delete. Maximum 200 IDs.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/billing/v1/cm_debtor?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/billing/v1/cm_debtor?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/billing/v1/cm_debtor?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", "/billing/v1/cm_debtor?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": "/billing/v1/cm_debtor?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/billing/v1/cm_debtor?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "Module record deleted"
}

Update an existing record in a custom module.
OAuth Scope : ZohoSubscriptions.custommodules.ALL

Arguments

record_name

string

(Required)

Name of the record

cf_debt_amount

number

Value of the custom Field

Path Parameters

module_name

string

(Required)

Module Name

module_id

string

(Required)

Custom Module ID

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/billing/v1/debtor/987000000654321?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/billing/v1/debtor/987000000654321?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/billing/v1/debtor/987000000654321?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", "/billing/v1/debtor/987000000654321?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": "/billing/v1/debtor/987000000654321?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/billing/v1/debtor/987000000654321?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "record_name": "Alice",
    "cf_debt_amount": 10000
}

{
    "code": 0,
    "message": "debtor is updated successfully.",
    "module_record": [
        {
            "module_record_id": "460000000639129",
            "module_api_name": "cm_debtor",
            "last_modified_time": "2022-02-18T11:00:45+0530",
            "last_modified_time_formatted": "18/02/2022 11:00 AM",
            "created_time": "2022-02-18T11:00:45+0530",
            "created_time_formatted": "2022-02-18T11:00:45+0530",
            "created_by_id": "2022-02-18T11:00:45+0530",
            "last_modified_by_id": "2112155000000069001",
            "record_name": "Alice",
            "record_name_formatted": "Alice",
            "cf_debt_amount": 10000,
            "cf_debt_amount_formatted": "₹10,000.00"
        },
        {...},
        {...}
    ]
}

Get the details of an individual record in a custom module.
OAuth Scope : ZohoSubscriptions.custommodules.ALL

Path Parameters

module_name

string

(Required)

Module Name

module_id

string

(Required)

Custom Module ID

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/billing/v1/debtor/987000000654321?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/billing/v1/debtor/987000000654321?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/billing/v1/debtor/987000000654321?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", "/billing/v1/debtor/987000000654321?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": "/billing/v1/debtor/987000000654321?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/billing/v1/debtor/987000000654321?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "success",
    "module_record": {
        "module_plural_name": "debtors",
        "comments": [
            {
                "date": "2022-02-17",
                "commented_by": "Staff Bob",
                "operation_type": "Added",
                "comment_type": "system",
                "date_formatted": "17/02/2022 12:09 AM",
                "description": "Record added.",
                "time": "12:09 AM",
                "comment_id": "3000000003061",
                "commented_by_id": "3000000002565"
            }
        ],
        "module_api_name": "cm_debtor",
        "shared_type": "read_write",
        "can_submit": false,
        "approvers_list": "",
        "can_approve": false,
        "module_name": "debtor",
        "module_fields": [
            {
                "field_id": 1,
                "is_active": true,
                "is_mandatory": true,
                "label": "debtor Name",
                "api_name": "record_name",
                "data_type_formatted": "Text Box (Single Line)",
                "value_formatted": "Alice",
                "data_type": "string",
                "pii_type": "non_pii",
                "value": "Alice",
                "max_length": 255,
                "help_text": ""
            }
        ],
        "module_record_id": 3000000003057,
        "shared_to": [
            460000000639128,
            460000000639129
        ]
    },
    "module_record_hash": {
        "module_record_id": "2022-02-17",
        "module_api_name": "cm_debtor",
        "last_modified_time": "2022-02-18T11:00:45+0530",
        "last_modified_time_formatted": "18/02/2022 11:00 AM",
        "created_time": "2022-02-18T11:00:45+0530",
        "created_time_formatted": "2022-02-18T11:00:45+0530",
        "created_by_id": "2112155000000069001",
        "last_modified_by_id": "2112155000000069001",
        "record_name": "Alice",
        "record_name_formatted": "Alice"
    },
    "users": [
        {
            "id": 2112155000000069000,
            "text": "Staff Bob",
            "name": "Staff Bob",
            "email": "string",
            "photo_url": "string",
            "is_current_user": true
        }
    ]
}

Delete an individual record from a custom module.
OAuth Scope : ZohoSubscriptions.custommodules.ALL

Path Parameters

module_name

string

(Required)

Module Name

module_id

string

(Required)

Custom Module ID

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/billing/v1/cm_debtor/2112155000000652000?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/billing/v1/cm_debtor/2112155000000652000?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/billing/v1/cm_debtor/2112155000000652000?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", "/billing/v1/cm_debtor/2112155000000652000?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": "/billing/v1/cm_debtor/2112155000000652000?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/billing/v1/cm_debtor/2112155000000652000?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "success"
}

Attribute

Create a custom module

Arguments

Query Parameters

List custom modules

Query Parameters

Update a custom module

Arguments

Path Parameters

Query Parameters

Get a custom module

Path Parameters

Query Parameters

Delete a custom module

Path Parameters

Query Parameters

Create a custom module record

Arguments

Path Parameters

Query Parameters

Bulk update custom module records

Arguments

Path Parameters

Query Parameters

List custom module records

Path Parameters

Query Parameters

Delete custom module records

Path Parameters

Query Parameters

Update a custom module record

Arguments

Path Parameters

Query Parameters

Get a custom module record

Path Parameters

Query Parameters

Delete a custom module record

Path Parameters

Query Parameters