Custom Modules

In Zoho Books, 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

/{module_name}/{module_id}

GET

/{module_name}/{module_id}

DELETE

/{module_name}/{module_id}

Attribute

module_record_id

long

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 Custom Modules

To create a custom module, you can use the argument below
OAuth Scope : ZohoBooks.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/books/v3/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/books/v3/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/books/v3/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", "/books/v3/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": "/books/v3/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/books/v3/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"
        },
        {...},
        {...}
    ]
}

Bulk Update Custom Module

To update existing custom module records in bulk, use the argument below
OAuth Scope : ZohoBooks.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/books/v3/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/books/v3/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/books/v3/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", "/books/v3/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": "/books/v3/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/books/v3/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 Record List of a Custom Module

To get the list of records of a custom module, you can use the argument below
OAuth Scope : ZohoBooks.custommodules.ALL

Path Parameters

module_name

string

(Required)

Module Name

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/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/books/v3/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/books/v3/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", "/books/v3/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": "/books/v3/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/books/v3/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 Custom Modules

To delete a custom module, you can use the argument below
OAuth Scope : ZohoBooks.custommodules.ALL

Path Parameters

module_name

string

(Required)

Module Name

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

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

Update Custom Module

To update an existing custom module, use the argument below
OAuth Scope : ZohoBooks.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

integer

(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/books/v3/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/books/v3/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/books/v3/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", "/books/v3/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": "/books/v3/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/books/v3/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 Individual Record Details

To get the details of an individual organisation, use the argument below.
OAuth Scope : ZohoBooks.custommodules.ALL

Path Parameters

module_name

string

(Required)

Module Name

module_id

integer

(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/books/v3/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/books/v3/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/books/v3/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", "/books/v3/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": "/books/v3/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/books/v3/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 individual records

to delete individual records of a custom module, use the argument below
OAuth Scope : ZohoBooks.custommodules.ALL

Path Parameters

module_name

string

(Required)

Module Name

module_id

integer

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

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