Tasks

Tasks are the to-dos that you and your users have to complete. You can set reminders for tasks that need your attention. Reminders help you stay organized by alerting you about due or upcoming tasks.

Download Tasks OpenAPI Document

End Points

POST

/tasks/{task_id}/percentage

POST

/tasks/{task_id}/markasopen

POST

/tasks/{task_id}/markasongoing

POST

/tasks/{task_id}/markascompleted

POST

/tasks/{task_id}/comments

GET

/tasks/{task_id}/comments

DELETE

/tasks/{task_id}/comments/{comment_id}

POST

/tasks/{task_id}/attachment

GET

/tasks/{task_id}/documents/{document_id}

DELETE

/tasks/{task_id}/documents/{document_id}

Attribute

task_id

string

ID of the task.

recurring_task_id

string

ID of the recurring task.

owner_id

string

ID of the owner of the task.

owner_ids

string

Comma separated list of owner IDs of the task.

owner_name

string

Name of the owner of the task.

owners

array

List of owners of the task.

Show Sub-Attributes

owner_id

string

ID of the owner of the task.

owner_name

string

Name of the owner of the task.

owner_mail

string

Email of the owner of the task.

photo_url

string

URL of the photo of the owner of the task.

title

string

Title of the task.

due_date

date

Due date of the task.

due_date_formatted

string

Formatted due date of the task.

is_overdue

boolean

Indicates whether the task is overdue.

contact_type

string

Type of the contact associated with the task. Allowed values are customer and vendor

contact_id

string

ID of the contact associated with the task.

color_code

string

Color code of the task.

contact_name

string

Name of the contact associated with the task.

parent_task_id

string

ID of the parent task.

related_entity_id

string

ID of the related entity associated with the task.

related_entity_type

string

Type of the related entity associated with the task.

related_entity

integer

Unique value assigned to each entity.

related_entity_value

string

Value of the related entity associated with the task.

parent_status

string

Parent status of the task.

status

string

Status of the task.

custom_status_id

string

ID of the custom status of the task.

billing_type

string

Billing type of the task.

is_billable

boolean

Indicates whether the task is billable.

task_rate

double

Rate of the task.

completion_percentage

integer

Completion percentage of the task.

is_subtask

boolean

Indicates whether the task is a subtask.

priority

string

Priority of the task. Allowed values are normal, low, high, lowest and highest

reminder

object

Details of the reminder set for the task.

Show Sub-Attributes

remind_before

integer

Number of days, months or years before the task due date to send a reminder.

remind_at

date

Specific date to send the reminder.

remind_at_formatted

string

Formatted date to send the reminder.

remind_type

string

Type of reminder which can be days, months or years.

remind_type_formatted

string

Formatted type of reminder which can be days, months or years.

alert_type

string

Type of alert for the reminder.

alert_type_formatted

string

Formatted type of alert for the reminder.

task_description

string

Description of the task.

is_accountant_task

boolean

Indicates whether the task is an accountant task.

task_number

string

Unique number assigned to the task.

task_number_prefix

string

Prefix of the task number.

task_number_suffix

string

Suffix of the task number.

can_push

boolean

Indicates if the task can be sync to client

created_by_id

string

ID of the user who created the task.

last_modified_by_id

string

ID of the user who last modified the task.

template_id

string

ID of the template used for the task.

due_after

integer

Number of days after which the task is due.

parent_task_name

string

Name of the parent task.

parent_task_number

string

Number of the parent task.

created_by_name

string

Name of the user who created the task.

{
    "task_id": 982000000567114,
    "recurring_task_id": 982000000567115,
    "owner_id": 982000000567116,
    "owner_ids": "982000000567116,982000000567117",
    "owner_name": "John Doe",
    "owners": [
        {
            "owner_id": 982000000567116,
            "owner_name": "John Doe",
            "owner_mail": "johndoe@example.com",
            "photo_url": "https://example.com/photo.jpg"
        }
    ],
    "title": "Sample Task",
    "due_date": "2025-12-31",
    "due_date_formatted": "31-12-2025",
    "is_overdue": true,
    "contact_type": "customer",
    "contact_id": 982000000567118,
    "color_code": "#FF5733",
    "contact_name": "Jane Smith",
    "parent_task_id": 982000000567119,
    "related_entity_id": 982000000567120,
    "related_entity_type": "invoice",
    "related_entity": 20,
    "related_entity_value": "INV-001",
    "parent_status": "open",
    "status": "open",
    "custom_status_id": 982000000567121,
    "billing_type": "based_on_task_hours",
    "is_billable": true,
    "task_rate": 50,
    "completion_percentage": 75,
    "is_subtask": false,
    "priority": "high",
    "reminder": {
        "remind_before": 2,
        "remind_at": "2025-12-29",
        "remind_at_formatted": "29-12-2025",
        "remind_type": "days",
        "remind_type_formatted": "Days",
        "alert_type": "email",
        "alert_type_formatted": "Email"
    },
    "task_description": "This is a sample task description.",
    "is_accountant_task": false,
    "task_number": "T-001",
    "task_number_prefix": "T-",
    "task_number_suffix": "-001",
    "can_push": true,
    "created_by_id": 982000000567122,
    "last_modified_by_id": 982000000567123,
    "template_id": 982000000567124,
    "due_after": 7,
    "parent_task_name": "Parent Task",
    "parent_task_number": "PT-001",
    "created_by_name": "John Doe"
}

Add a task.
OAuth Scope : ZohoSubscriptions.settings.CREATE

Arguments

task_id

string

ID of the task.

owner_ids

string

Comma separated list of owner IDs of the task.

owner_id

string

ID of the owner of the task.

task_type

string

Type of the task.

title

string

Title of the task.

due_date

date

Due date of the task.

contact_type

string

Type of the contact associated with the task. Allowed values are customer and vendor

contact_id

string

ID of the contact associated with the task.

can_push

boolean

Indicates if the task can be sync to client

related_entity_type

string

Type of the related entity associated with the task.

related_entity_id

string

ID of the related entity associated with the task.

related_sub_entity_type

string

Type of the related sub entity associated with the task.

related_sub_entity_id

string

ID of the related sub entity associated with the task.

status

string

Status of the task.

billing_type

string

Billing type of the task.

is_billable

boolean

Indicates whether the task is billable.

task_rate

double

Rate of the task.

completion_percentage

integer

Completion percentage of the task.

priority

string

Priority of the task. Allowed values are normal, low, high, lowest and highest

send_email_notification

boolean

Indicates whether to send email notification for the task.

mail_id

string

Email ID to which the notification has to be sent.

email_account_type

string

Email account type to which the notification has to be sent.

email_folder_id

string

Folder ID of the email account to which the notification has to be sent.

email_account_id

string

Email account ID to which the notification has to be sent.

mail_attachments

array

List of attachments to be sent along with the email notification.

Show Sub-Attributes

attachment_id

string

ID of the attachment to be sent along with the email notification.

file_name

string

Name of the file attached to the email notification.

reminder

object

Details of the reminder set for the task.

Show Sub-Attributes

remind_before

integer

Number of days, months or years before the task due date to send a reminder.

remind_at

date

Specific date to send the reminder.

remind_at_formatted

string

Formatted date to send the reminder.

remind_type

string

Type of reminder which can be days, months or years.

remind_type_formatted

string

Formatted type of reminder which can be days, months or years.

alert_type

string

Type of alert for the reminder.

alert_type_formatted

string

Formatted type of alert for the reminder.

task_description

string

Description of the task.

custom_fields

array

Show Sub-Attributes

customfield_id

string

ID of the custom field.

index

integer

Index of the custom field.

label

string

Label of the custom field.

value

string

Value of the custom field.

value_formatted

string

Formatted value of the custom field.

api_name

string

Name of the custom field.

due_after

integer

Number of days after which the task is due.

template_id

string

ID of the template used for the task.

task_number

string

Unique number assigned to the task.

task_number_prefix

string

Prefix of the task number.

task_number_suffix

string

Suffix of the task number.

recurring_task_id

string

ID of the recurring task.

is_sub_task

boolean

Indicates whether the task is a sub task.

parent_id

string

ID of the parent task.

dependencies

array

List of dependencies for the task.

Show Sub-Attributes

dependency_id

string

ID of the dependency.

dependency_type

integer

Type of the dependency.

depends_on_id

string

ID of the entity on which the current task depends.

depends_on_entity_type

integer

Type of the entity on which the current task depends.

entity_tags

array

List of tags to be associated with the task.

Show Sub-Attributes

name

string

Name of the tag.

color

string

Color code of the tag.

Headers

X-com-zoho-subscriptions-organizationid

string

(Required)

ID of the organization

Request Example

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

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

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

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

import http.client

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

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

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

conn.request("POST", "/billing/v3/tasks", 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/v3/tasks",
  "headers": {
    "X-com-zoho-subscriptions-organizationid": "10234695",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

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

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

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

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

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

{
    "task_id": 982000000567114,
    "owner_ids": "982000000567116,982000000567117",
    "owner_id": 982000000567116,
    "task_type": "accountant task",
    "title": "Sample Task",
    "due_date": "2025-12-31",
    "contact_type": "customer",
    "contact_id": 982000000567118,
    "can_push": true,
    "related_entity_type": "invoice",
    "related_entity_id": 982000000567120,
    "related_sub_entity_type": "expense_report",
    "related_sub_entity_id": 982000000567122,
    "status": "open",
    "billing_type": "based_on_task_hours",
    "is_billable": true,
    "task_rate": 50,
    "completion_percentage": 75,
    "priority": "high",
    "send_email_notification": true,
    "mail_id": "johndoe@gmail.com",
    "email_account_type": "gmail",
    "email_folder_id": "982000000567126",
    "email_account_id": "982000000567127",
    "mail_attachments": [
        {
            "attachment_id": "982000000567128",
            "file_name": "document.pdf"
        }
    ],
    "reminder": {
        "remind_before": 2,
        "remind_at": "2025-12-29",
        "remind_at_formatted": "29-12-2025",
        "remind_type": "days",
        "remind_type_formatted": "Days",
        "alert_type": "email",
        "alert_type_formatted": "Email"
    },
    "task_description": "This is a sample task description.",
    "custom_fields": [
        {
            "customfield_id": 982000000567114,
            "index": 1,
            "label": "Custom Field Label",
            "value": "Custom Field Value",
            "value_formatted": "Formatted Custom Field Value",
            "api_name": "CustomFieldAPIName"
        }
    ],
    "due_after": 7,
    "template_id": 982000000567124,
    "task_number": "T-001",
    "task_number_prefix": "T-",
    "task_number_suffix": "-001",
    "recurring_task_id": 982000000567115,
    "is_sub_task": false,
    "parent_id": 982000000567114,
    "dependencies": [
        {
            "dependency_id": 982000000567192,
            "dependency_type": 1,
            "depends_on_id": 982000000567193,
            "depends_on_entity_type": 20
        }
    ],
    "entity_tags": [
        {
            "name": "Important",
            "color": "FFB6C1"
        }
    ]
}

{
    "code": 0,
    "message": "Task created",
    "task": {
        "task_id": 982000000567114,
        "recurring_task_id": 982000000567115,
        "owner_id": 982000000567116,
        "owner_ids": "982000000567116,982000000567117",
        "owner_name": "John Doe",
        "owners": [
            {
                "owner_id": 982000000567116,
                "owner_name": "John Doe",
                "owner_mail": "johndoe@example.com",
                "photo_url": "https://example.com/photo.jpg"
            }
        ],
        "title": "Sample Task",
        "due_date": "2025-12-31",
        "due_date_formatted": "31-12-2025",
        "is_overdue": true,
        "contact_type": "customer",
        "contact_id": 982000000567118,
        "color_code": "#FF5733",
        "contact_name": "Jane Smith",
        "parent_task_id": 982000000567119,
        "related_entity_id": 982000000567120,
        "related_entity_type": "invoice",
        "related_entity": 20,
        "related_entity_value": "INV-001",
        "parent_status": "open",
        "status": "open",
        "custom_status_id": 982000000567121,
        "billing_type": "based_on_task_hours",
        "is_billable": true,
        "task_rate": 50,
        "completion_percentage": 75,
        "is_subtask": false,
        "priority": "high",
        "reminder": {
            "remind_before": 2,
            "remind_at": "2025-12-29",
            "remind_at_formatted": "29-12-2025",
            "remind_type": "days",
            "remind_type_formatted": "Days",
            "alert_type": "email",
            "alert_type_formatted": "Email"
        },
        "task_description": "This is a sample task description.",
        "is_accountant_task": false,
        "task_number": "T-001",
        "task_number_prefix": "T-",
        "task_number_suffix": "-001",
        "can_push": true,
        "created_by_id": 982000000567122,
        "last_modified_by_id": 982000000567123,
        "template_id": 982000000567124,
        "due_after": 7,
        "parent_task_name": "Parent Task",
        "parent_task_number": "PT-001",
        "created_by_name": "John Doe",
        "documents": [
            {
                "can_show_in_portal": true,
                "file_name": "document.pdf",
                "file_type": "pdf",
                "file_size": 204800,
                "file_size_formatted": "200 KB",
                "document_id": 982000000567125,
                "attachment_order": 1
            }
        ],
        "custom_fields": [
            {
                "customfield_id": "46000000012845",
                "edit_on_store": "false",
                "show_in_all_pdf": "true",
                "search_entity": "contacts",
                "value": "Value123",
                "value_formatted": "Value123",
                "show_in_store": "false",
                "is_active": "true",
                "order": "1",
                "label": "Project Code",
                "api_name": "cf_project_code",
                "data_type": "text",
                "is_dependent_field": "false",
                "show_in_portal": "true",
                "show_on_pdf": "true",
                "edit_on_portal": "false"
            }
        ],
        "statuses": [
            "open",
            "closed",
            "pending"
        ],
        "is_system_task": false,
        "system_task_type": 2,
        "comments": [
            {
                "comment_id": 982000000567126,
                "description": "This is a sample comment.",
                "commented_by_id": 982000000567127,
                "commented_by": "Jane Doe",
                "comment_type": "internal",
                "date": "2025-01-01T12:00:00Z",
                "date_description": "One month ago",
                "time": "12:00 PM",
                "operation_type": "Added",
                "transaction_id": 982000000567128,
                "transaction_type": "invoice"
            }
        ],
        "dependencies": [
            {
                "dependency_id": 982000000567192,
                "dependency_type": 1,
                "depends_on_id": 982000000567193,
                "depends_on_entity_type": 20
            }
        ],
        "entity_tags": [
            {
                "id": 982000000567129,
                "name": "Important",
                "color": "FFB6C1"
            }
        ]
    }
}

Update tasks.
OAuth Scope : ZohoSubscriptions.settings.UPDATE

Arguments

task_id

string

ID of the task.

owner_ids

string

Comma separated list of owner IDs of the task.

owner_id

string

ID of the owner of the task.

task_type

string

Type of the task.

title

string

Title of the task.

due_date

date

Due date of the task.

contact_type

string

Type of the contact associated with the task. Allowed values are customer and vendor

contact_id

string

ID of the contact associated with the task.

can_push

boolean

Indicates if the task can be sync to client

related_entity_type

string

Type of the related entity associated with the task.

related_entity_id

string

ID of the related entity associated with the task.

related_sub_entity_type

string

Type of the related sub entity associated with the task.

related_sub_entity_id

string

ID of the related sub entity associated with the task.

status

string

Status of the task.

billing_type

string

Billing type of the task.

is_billable

boolean

Indicates whether the task is billable.

task_rate

double

Rate of the task.

completion_percentage

integer

Completion percentage of the task.

priority

string

Priority of the task. Allowed values are normal, low, high, lowest and highest

send_email_notification

boolean

Indicates whether to send email notification for the task.

mail_id

string

Email ID to which the notification has to be sent.

email_account_type

string

Email account type to which the notification has to be sent.

email_folder_id

string

Folder ID of the email account to which the notification has to be sent.

email_account_id

string

Email account ID to which the notification has to be sent.

mail_attachments

array

List of attachments to be sent along with the email notification.

Show Sub-Attributes

attachment_id

string

ID of the attachment to be sent along with the email notification.

file_name

string

Name of the file attached to the email notification.

reminder

object

Details of the reminder set for the task.

Show Sub-Attributes

remind_before

integer

Number of days, months or years before the task due date to send a reminder.

remind_at

date

Specific date to send the reminder.

remind_at_formatted

string

Formatted date to send the reminder.

remind_type

string

Type of reminder which can be days, months or years.

remind_type_formatted

string

Formatted type of reminder which can be days, months or years.

alert_type

string

Type of alert for the reminder.

alert_type_formatted

string

Formatted type of alert for the reminder.

task_description

string

Description of the task.

custom_fields

array

Show Sub-Attributes

customfield_id

string

ID of the custom field.

index

integer

Index of the custom field.

label

string

Label of the custom field.

value

string

Value of the custom field.

value_formatted

string

Formatted value of the custom field.

api_name

string

Name of the custom field.

due_after

integer

Number of days after which the task is due.

template_id

string

ID of the template used for the task.

task_number

string

Unique number assigned to the task.

task_number_prefix

string

Prefix of the task number.

task_number_suffix

string

Suffix of the task number.

recurring_task_id

string

ID of the recurring task.

is_sub_task

boolean

Indicates whether the task is a sub task.

parent_id

string

ID of the parent task.

dependencies

array

List of dependencies for the task.

Show Sub-Attributes

dependency_id

string

ID of the dependency.

dependency_type

integer

Type of the dependency.

depends_on_id

string

ID of the entity on which the current task depends.

depends_on_entity_type

integer

Type of the entity on which the current task depends.

entity_tags

array

List of tags to be associated with the task.

Show Sub-Attributes

name

string

Name of the tag.

color

string

Color code of the tag.

Query Parameters

bulk_update

boolean

(Required)

Indicate whether the request is for bulk update. Allowed values are true and false.

Headers

X-com-zoho-subscriptions-organizationid

string

(Required)

ID of the organization

Request Example

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

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

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

fetch('https://www.zohoapis.com/billing/v3/tasks?bulk_update=true', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

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

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

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

conn.request("PUT", "/billing/v3/tasks?bulk_update=true", 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/v3/tasks?bulk_update=true",
  "headers": {
    "X-com-zoho-subscriptions-organizationid": "10234695",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

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

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

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

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

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

[
    {
        "task_id": 982000000567114,
        "owner_ids": "982000000567116,982000000567117",
        "owner_id": 982000000567116,
        "task_type": "accountant task",
        "title": "Sample Task",
        "due_date": "2025-12-31",
        "contact_type": "customer",
        "contact_id": 982000000567118,
        "can_push": true,
        "related_entity_type": "invoice",
        "related_entity_id": 982000000567120,
        "related_sub_entity_type": "expense_report",
        "related_sub_entity_id": 982000000567122,
        "status": "open",
        "billing_type": "based_on_task_hours",
        "is_billable": true,
        "task_rate": 50,
        "completion_percentage": 75,
        "priority": "high",
        "send_email_notification": true,
        "mail_id": "johndoe@gmail.com",
        "email_account_type": "gmail",
        "email_folder_id": "982000000567126",
        "email_account_id": "982000000567127",
        "mail_attachments": [
            {
                "attachment_id": "982000000567128",
                "file_name": "document.pdf"
            }
        ],
        "reminder": {
            "remind_before": 2,
            "remind_at": "2025-12-29",
            "remind_at_formatted": "29-12-2025",
            "remind_type": "days",
            "remind_type_formatted": "Days",
            "alert_type": "email",
            "alert_type_formatted": "Email"
        },
        "task_description": "This is a sample task description.",
        "custom_fields": [
            {
                "customfield_id": 982000000567114,
                "index": 1,
                "label": "Custom Field Label",
                "value": "Custom Field Value",
                "value_formatted": "Formatted Custom Field Value",
                "api_name": "CustomFieldAPIName"
            }
        ],
        "due_after": 7,
        "template_id": 982000000567124,
        "task_number": "T-001",
        "task_number_prefix": "T-",
        "task_number_suffix": "-001",
        "recurring_task_id": 982000000567115,
        "is_sub_task": false,
        "parent_id": 982000000567114,
        "dependencies": [
            {
                "dependency_id": 982000000567192,
                "dependency_type": 1,
                "depends_on_id": 982000000567193,
                "depends_on_entity_type": 20
            }
        ],
        "entity_tags": [
            {
                "name": "Important",
                "color": "FFB6C1"
            }
        ]
    }
]

{
    "code": 0,
    "message": "Task updated",
    "tasks": [
        {
            "task_id": 982000000567114,
            "recurring_task_id": 982000000567115,
            "owner_id": 982000000567116,
            "owner_ids": "982000000567116,982000000567117",
            "owner_name": "John Doe",
            "owners": [
                {
                    "owner_id": 982000000567116,
                    "owner_name": "John Doe",
                    "owner_mail": "johndoe@example.com",
                    "photo_url": "https://example.com/photo.jpg"
                }
            ],
            "title": "Sample Task",
            "due_date": "2025-12-31",
            "due_date_formatted": "31-12-2025",
            "is_overdue": true,
            "contact_type": "customer",
            "contact_id": 982000000567118,
            "color_code": "#FF5733",
            "contact_name": "Jane Smith",
            "parent_task_id": 982000000567119,
            "related_entity_id": 982000000567120,
            "related_entity_type": "invoice",
            "related_entity": 20,
            "related_entity_value": "INV-001",
            "parent_status": "open",
            "status": "open",
            "custom_status_id": 982000000567121,
            "billing_type": "based_on_task_hours",
            "is_billable": true,
            "task_rate": 50,
            "completion_percentage": 75,
            "is_subtask": false,
            "priority": "high",
            "reminder": {
                "remind_before": 2,
                "remind_at": "2025-12-29",
                "remind_at_formatted": "29-12-2025",
                "remind_type": "days",
                "remind_type_formatted": "Days",
                "alert_type": "email",
                "alert_type_formatted": "Email"
            },
            "task_description": "This is a sample task description.",
            "is_accountant_task": false,
            "task_number": "T-001",
            "task_number_prefix": "T-",
            "task_number_suffix": "-001",
            "can_push": true,
            "created_by_id": 982000000567122,
            "last_modified_by_id": 982000000567123,
            "template_id": 982000000567124,
            "due_after": 7,
            "parent_task_name": "Parent Task",
            "parent_task_number": "PT-001",
            "created_by_name": "John Doe",
            "documents": [
                {
                    "can_show_in_portal": true,
                    "file_name": "document.pdf",
                    "file_type": "pdf",
                    "file_size": 204800,
                    "file_size_formatted": "200 KB",
                    "document_id": 982000000567125,
                    "attachment_order": 1
                }
            ],
            "custom_fields": [
                {
                    "customfield_id": "46000000012845",
                    "edit_on_store": "false",
                    "show_in_all_pdf": "true",
                    "search_entity": "contacts",
                    "value": "Value123",
                    "value_formatted": "Value123",
                    "show_in_store": "false",
                    "is_active": "true",
                    "order": "1",
                    "label": "Project Code",
                    "api_name": "cf_project_code",
                    "data_type": "text",
                    "is_dependent_field": "false",
                    "show_in_portal": "true",
                    "show_on_pdf": "true",
                    "edit_on_portal": "false"
                }
            ],
            "statuses": [
                "open",
                "closed",
                "pending"
            ],
            "is_system_task": false,
            "system_task_type": 2,
            "comments": [
                {
                    "comment_id": 982000000567126,
                    "description": "This is a sample comment.",
                    "commented_by_id": 982000000567127,
                    "commented_by": "Jane Doe",
                    "comment_type": "internal",
                    "date": "2025-01-01T12:00:00Z",
                    "date_description": "One month ago",
                    "time": "12:00 PM",
                    "operation_type": "Added",
                    "transaction_id": 982000000567128,
                    "transaction_type": "invoice"
                }
            ],
            "dependencies": [
                {
                    "dependency_id": 982000000567192,
                    "dependency_type": 1,
                    "depends_on_id": 982000000567193,
                    "depends_on_entity_type": 20
                }
            ],
            "entity_tags": [
                {
                    "id": 982000000567129,
                    "name": "Important",
                    "color": "FFB6C1"
                }
            ]
        },
        {...},
        {...}
    ]
}

List a task.
OAuth Scope : ZohoSubscriptions.settings.READ

Query Parameters

entity_id

string

Search tasks by entity ID.

sub_entity_id

string

Search tasks by sub entity ID.

owner_id

string

Search tasks by owner ID.

contact_id

string

Search tasks by contact ID.

client_id

string

Search tasks by client ID.

status

string

Search tasks by status. Allowed values are open, ongoing, yet_to_started, in_progress, completed, deferred, waiting_for_input and any custom status

parent_status

string

Search tasks by parent status. Allowed formats are parent_status, parent_status_equal and parent_status_not_equal. Allowed values are open, ongoing and completed

search_text

string

Search tasks based on a search text.

priority

string

Search tasks by priority of the task. Allowed values are normal, low, high, lowest and highest.

entity_type

string

Search tasks by entity type.

title

string

Search tasks by their title.

task_description

string

Search tasks their description.

is_overdue

string

Filter overdue tasks.

created_by

string

Search tasks by the person who created them.

is_accountant_task

string

Filter accountant tasks.

contact_ids

string

Search tasks by contact IDs separated by comma.

client_ids

string

Search tasks by client IDs separated by comma.

owner_ids

string

Search tasks by owner IDs separated by comma.

date_start

string

Search tasks by start date.

date_end

string

Search tasks by end date.

task_number

string

Search tasks by task number.

sort_column

string

Sort tasks. Allowed values are owner_name, contact_name, client_name, due_date, title, created_time, completion_percentage and task_number

filter_by

string

Filter tasks by status. Allowed values are TaskStatus.All, TaskStatus.Overdue, TaskStatus.InProgress, TaskStatus.Completed, TaskStatus.YetToStarted, TaskStatus.MyPending, TaskStatus.DueToday, TaskStatus.PriorityOverdue and TaskStatus.Unassigned

page

integer

Page number to be fetched. Default value is 1.

per_page

integer

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

Headers

X-com-zoho-subscriptions-organizationid

string

(Required)

ID of the organization

Request Example

headers_data = Map();
headers_data.put("X-com-zoho-subscriptions-organizationid", "10234695");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/billing/v3/tasks"
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/v3/tasks")
  .get()
  .addHeader("X-com-zoho-subscriptions-organizationid", "10234695")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

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

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

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

import http.client

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

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

conn.request("GET", "/billing/v3/tasks", 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/v3/tasks",
  "headers": {
    "X-com-zoho-subscriptions-organizationid": "10234695",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

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

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

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

req.end();

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

{
    "code": 0,
    "message": "success",
    "tasks": [
        {
            "task_id": 982000000567114,
            "task_number": "T-001",
            "owner_id": 982000000567116,
            "owner_name": "John Doe",
            "contact_id": 982000000567118,
            "billing_type": "based_on_task_hours",
            "is_billable": true,
            "task_rate": 50,
            "completion_percentage": 75,
            "contact_name": "Jane Smith",
            "contact_type": "customer",
            "client_id": 982000000567118,
            "client_name": "Acme Corporation",
            "title": "Sample Task",
            "created_time": "2025-01-01T10:00:00Z",
            "created_time_formatted": "01-01-2025 10:00:00",
            "due_date": "2025-12-31",
            "is_accountant_task": false,
            "is_overdue": true,
            "parent_task_id": 982000000567119,
            "parent_status": "open",
            "priority": "high",
            "status": "open",
            "color_code": "#FF5733",
            "task_description": "This is a sample task description.",
            "subtask_count": 3,
            "is_subtask": false,
            "parent_task_name": "Parent Task",
            "parent_task_number": "PT-001",
            "custom_fields": [
                {
                    "customfield_id": "46000000012845",
                    "edit_on_store": "false",
                    "show_in_all_pdf": "true",
                    "search_entity": "contacts",
                    "value": "Value123",
                    "value_formatted": "Value123",
                    "show_in_store": "false",
                    "is_active": "true",
                    "order": "1",
                    "label": "Project Code",
                    "api_name": "cf_project_code",
                    "data_type": "text",
                    "is_dependent_field": "false",
                    "show_in_portal": "true",
                    "show_on_pdf": "true",
                    "edit_on_portal": "false"
                }
            ],
            "owners": [
                {
                    "owner_id": 982000000567116,
                    "owner_name": "John Doe",
                    "owner_mail": "johndoe@example.com",
                    "photo_url": "https://example.com/photo.jpg"
                }
            ],
            "entity_tags": [
                {
                    "id": 982000000567129,
                    "name": "Important",
                    "color": "FFB6C1"
                }
            ]
        },
        {...},
        {...}
    ]
}

Delete tasks.
OAuth Scope : ZohoSubscriptions.settings.DELETE

Query Parameters

task_ids

string

(Required)

Comma separated list of task IDs to be deleted.

Headers

X-com-zoho-subscriptions-organizationid

string

(Required)

ID of the organization

Request Example

headers_data = Map();
headers_data.put("X-com-zoho-subscriptions-organizationid", "10234695");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/billing/v3/tasks?task_ids=982000000567114,982000000567115,982000000567116"
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/v3/tasks?task_ids=982000000567114%2C982000000567115%2C982000000567116")
  .delete(null)
  .addHeader("X-com-zoho-subscriptions-organizationid", "10234695")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

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

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

fetch('https://www.zohoapis.com/billing/v3/tasks?task_ids=982000000567114%2C982000000567115%2C982000000567116', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

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

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

conn.request("DELETE", "/billing/v3/tasks?task_ids=982000000567114%2C982000000567115%2C982000000567116", 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/v3/tasks?task_ids=982000000567114%2C982000000567115%2C982000000567116",
  "headers": {
    "X-com-zoho-subscriptions-organizationid": "10234695",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

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

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

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

req.end();

curl --request DELETE \
  --url 'https://www.zohoapis.com/billing/v3/tasks?task_ids=982000000567114%2C982000000567115%2C982000000567116' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'X-com-zoho-subscriptions-organizationid: 10234695'

{
    "code": 0,
    "message": "Task deleted"
}

Update a tasks.
OAuth Scope : ZohoSubscriptions.settings.UPDATE

Arguments

task_id

string

ID of the task.

owner_ids

string

Comma separated list of owner IDs of the task.

owner_id

string

ID of the owner of the task.

task_type

string

Type of the task.

title

string

Title of the task.

due_date

date

Due date of the task.

contact_type

string

Type of the contact associated with the task. Allowed values are customer and vendor

contact_id

string

ID of the contact associated with the task.

can_push

boolean

Indicates if the task can be sync to client

related_entity_type

string

Type of the related entity associated with the task.

related_entity_id

string

ID of the related entity associated with the task.

related_sub_entity_type

string

Type of the related sub entity associated with the task.

related_sub_entity_id

string

ID of the related sub entity associated with the task.

status

string

Status of the task.

billing_type

string

Billing type of the task.

is_billable

boolean

Indicates whether the task is billable.

task_rate

double

Rate of the task.

completion_percentage

integer

Completion percentage of the task.

priority

string

Priority of the task. Allowed values are normal, low, high, lowest and highest

send_email_notification

boolean

Indicates whether to send email notification for the task.

mail_id

string

Email ID to which the notification has to be sent.

email_account_type

string

Email account type to which the notification has to be sent.

email_folder_id

string

Folder ID of the email account to which the notification has to be sent.

email_account_id

string

Email account ID to which the notification has to be sent.

mail_attachments

array

List of attachments to be sent along with the email notification.

Show Sub-Attributes

attachment_id

string

ID of the attachment to be sent along with the email notification.

file_name

string

Name of the file attached to the email notification.

reminder

object

Details of the reminder set for the task.

Show Sub-Attributes

remind_before

integer

Number of days, months or years before the task due date to send a reminder.

remind_at

date

Specific date to send the reminder.

remind_at_formatted

string

Formatted date to send the reminder.

remind_type

string

Type of reminder which can be days, months or years.

remind_type_formatted

string

Formatted type of reminder which can be days, months or years.

alert_type

string

Type of alert for the reminder.

alert_type_formatted

string

Formatted type of alert for the reminder.

task_description

string

Description of the task.

custom_fields

array

Show Sub-Attributes

customfield_id

string

ID of the custom field.

index

integer

Index of the custom field.

label

string

Label of the custom field.

value

string

Value of the custom field.

value_formatted

string

Formatted value of the custom field.

api_name

string

Name of the custom field.

due_after

integer

Number of days after which the task is due.

template_id

string

ID of the template used for the task.

task_number

string

Unique number assigned to the task.

task_number_prefix

string

Prefix of the task number.

task_number_suffix

string

Suffix of the task number.

recurring_task_id

string

ID of the recurring task.

is_sub_task

boolean

Indicates whether the task is a sub task.

parent_id

string

ID of the parent task.

dependencies

array

List of dependencies for the task.

Show Sub-Attributes

dependency_id

string

ID of the dependency.

dependency_type

integer

Type of the dependency.

depends_on_id

string

ID of the entity on which the current task depends.

depends_on_entity_type

integer

Type of the entity on which the current task depends.

entity_tags

array

List of tags to be associated with the task.

Show Sub-Attributes

name

string

Name of the tag.

color

string

Color code of the tag.

Path Parameters

task_id

string

(Required)

Headers

X-com-zoho-subscriptions-organizationid

string

(Required)

ID of the organization

Request Example

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

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

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

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

import http.client

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

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

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

conn.request("PUT", "/billing/v3/tasks/982000000567114", 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/v3/tasks/982000000567114",
  "headers": {
    "X-com-zoho-subscriptions-organizationid": "10234695",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

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

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

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

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

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

{
    "task_id": 982000000567114,
    "owner_ids": "982000000567116,982000000567117",
    "owner_id": 982000000567116,
    "task_type": "accountant task",
    "title": "Sample Task",
    "due_date": "2025-12-31",
    "contact_type": "customer",
    "contact_id": 982000000567118,
    "can_push": true,
    "related_entity_type": "invoice",
    "related_entity_id": 982000000567120,
    "related_sub_entity_type": "expense_report",
    "related_sub_entity_id": 982000000567122,
    "status": "open",
    "billing_type": "based_on_task_hours",
    "is_billable": true,
    "task_rate": 50,
    "completion_percentage": 75,
    "priority": "high",
    "send_email_notification": true,
    "mail_id": "johndoe@gmail.com",
    "email_account_type": "gmail",
    "email_folder_id": "982000000567126",
    "email_account_id": "982000000567127",
    "mail_attachments": [
        {
            "attachment_id": "982000000567128",
            "file_name": "document.pdf"
        }
    ],
    "reminder": {
        "remind_before": 2,
        "remind_at": "2025-12-29",
        "remind_at_formatted": "29-12-2025",
        "remind_type": "days",
        "remind_type_formatted": "Days",
        "alert_type": "email",
        "alert_type_formatted": "Email"
    },
    "task_description": "This is a sample task description.",
    "custom_fields": [
        {
            "customfield_id": 982000000567114,
            "index": 1,
            "label": "Custom Field Label",
            "value": "Custom Field Value",
            "value_formatted": "Formatted Custom Field Value",
            "api_name": "CustomFieldAPIName"
        }
    ],
    "due_after": 7,
    "template_id": 982000000567124,
    "task_number": "T-001",
    "task_number_prefix": "T-",
    "task_number_suffix": "-001",
    "recurring_task_id": 982000000567115,
    "is_sub_task": false,
    "parent_id": 982000000567114,
    "dependencies": [
        {
            "dependency_id": 982000000567192,
            "dependency_type": 1,
            "depends_on_id": 982000000567193,
            "depends_on_entity_type": 20
        }
    ],
    "entity_tags": [
        {
            "name": "Important",
            "color": "FFB6C1"
        }
    ]
}

{
    "code": 0,
    "message": "Task updated",
    "task": {
        "task_id": 982000000567114,
        "recurring_task_id": 982000000567115,
        "owner_id": 982000000567116,
        "owner_ids": "982000000567116,982000000567117",
        "owner_name": "John Doe",
        "owners": [
            {
                "owner_id": 982000000567116,
                "owner_name": "John Doe",
                "owner_mail": "johndoe@example.com",
                "photo_url": "https://example.com/photo.jpg"
            }
        ],
        "title": "Sample Task",
        "due_date": "2025-12-31",
        "due_date_formatted": "31-12-2025",
        "is_overdue": true,
        "contact_type": "customer",
        "contact_id": 982000000567118,
        "color_code": "#FF5733",
        "contact_name": "Jane Smith",
        "parent_task_id": 982000000567119,
        "related_entity_id": 982000000567120,
        "related_entity_type": "invoice",
        "related_entity": 20,
        "related_entity_value": "INV-001",
        "parent_status": "open",
        "status": "open",
        "custom_status_id": 982000000567121,
        "billing_type": "based_on_task_hours",
        "is_billable": true,
        "task_rate": 50,
        "completion_percentage": 75,
        "is_subtask": false,
        "priority": "high",
        "reminder": {
            "remind_before": 2,
            "remind_at": "2025-12-29",
            "remind_at_formatted": "29-12-2025",
            "remind_type": "days",
            "remind_type_formatted": "Days",
            "alert_type": "email",
            "alert_type_formatted": "Email"
        },
        "task_description": "This is a sample task description.",
        "is_accountant_task": false,
        "task_number": "T-001",
        "task_number_prefix": "T-",
        "task_number_suffix": "-001",
        "can_push": true,
        "created_by_id": 982000000567122,
        "last_modified_by_id": 982000000567123,
        "template_id": 982000000567124,
        "due_after": 7,
        "parent_task_name": "Parent Task",
        "parent_task_number": "PT-001",
        "created_by_name": "John Doe",
        "documents": [
            {
                "can_show_in_portal": true,
                "file_name": "document.pdf",
                "file_type": "pdf",
                "file_size": 204800,
                "file_size_formatted": "200 KB",
                "document_id": 982000000567125,
                "attachment_order": 1
            }
        ],
        "custom_fields": [
            {
                "customfield_id": "46000000012845",
                "edit_on_store": "false",
                "show_in_all_pdf": "true",
                "search_entity": "contacts",
                "value": "Value123",
                "value_formatted": "Value123",
                "show_in_store": "false",
                "is_active": "true",
                "order": "1",
                "label": "Project Code",
                "api_name": "cf_project_code",
                "data_type": "text",
                "is_dependent_field": "false",
                "show_in_portal": "true",
                "show_on_pdf": "true",
                "edit_on_portal": "false"
            }
        ],
        "statuses": [
            "open",
            "closed",
            "pending"
        ],
        "is_system_task": false,
        "system_task_type": 2,
        "comments": [
            {
                "comment_id": 982000000567126,
                "description": "This is a sample comment.",
                "commented_by_id": 982000000567127,
                "commented_by": "Jane Doe",
                "comment_type": "internal",
                "date": "2025-01-01T12:00:00Z",
                "date_description": "One month ago",
                "time": "12:00 PM",
                "operation_type": "Added",
                "transaction_id": 982000000567128,
                "transaction_type": "invoice"
            }
        ],
        "dependencies": [
            {
                "dependency_id": 982000000567192,
                "dependency_type": 1,
                "depends_on_id": 982000000567193,
                "depends_on_entity_type": 20
            }
        ],
        "entity_tags": [
            {
                "id": 982000000567129,
                "name": "Important",
                "color": "FFB6C1"
            }
        ]
    }
}

Get a task.
OAuth Scope : ZohoSubscriptions.settings.READ

Path Parameters

task_id

string

(Required)

Headers

X-com-zoho-subscriptions-organizationid

string

(Required)

ID of the organization

Request Example

headers_data = Map();
headers_data.put("X-com-zoho-subscriptions-organizationid", "10234695");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/billing/v3/tasks/982000000567114"
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/v3/tasks/982000000567114")
  .get()
  .addHeader("X-com-zoho-subscriptions-organizationid", "10234695")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

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

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

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

import http.client

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

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

conn.request("GET", "/billing/v3/tasks/982000000567114", 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/v3/tasks/982000000567114",
  "headers": {
    "X-com-zoho-subscriptions-organizationid": "10234695",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

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

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

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

req.end();

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

{
    "code": 0,
    "message": "success",
    "task": {
        "task_id": 982000000567114,
        "recurring_task_id": 982000000567115,
        "owner_id": 982000000567116,
        "owner_ids": "982000000567116,982000000567117",
        "owner_name": "John Doe",
        "owners": [
            {
                "owner_id": 982000000567116,
                "owner_name": "John Doe",
                "owner_mail": "johndoe@example.com",
                "photo_url": "https://example.com/photo.jpg"
            }
        ],
        "title": "Sample Task",
        "due_date": "2025-12-31",
        "due_date_formatted": "31-12-2025",
        "is_overdue": true,
        "contact_type": "customer",
        "contact_id": 982000000567118,
        "color_code": "#FF5733",
        "contact_name": "Jane Smith",
        "parent_task_id": 982000000567119,
        "related_entity_id": 982000000567120,
        "related_entity_type": "invoice",
        "related_entity": 20,
        "related_entity_value": "INV-001",
        "parent_status": "open",
        "status": "open",
        "custom_status_id": 982000000567121,
        "billing_type": "based_on_task_hours",
        "is_billable": true,
        "task_rate": 50,
        "completion_percentage": 75,
        "is_subtask": false,
        "priority": "high",
        "reminder": {
            "remind_before": 2,
            "remind_at": "2025-12-29",
            "remind_at_formatted": "29-12-2025",
            "remind_type": "days",
            "remind_type_formatted": "Days",
            "alert_type": "email",
            "alert_type_formatted": "Email"
        },
        "task_description": "This is a sample task description.",
        "is_accountant_task": false,
        "task_number": "T-001",
        "task_number_prefix": "T-",
        "task_number_suffix": "-001",
        "can_push": true,
        "created_by_id": 982000000567122,
        "last_modified_by_id": 982000000567123,
        "template_id": 982000000567124,
        "due_after": 7,
        "parent_task_name": "Parent Task",
        "parent_task_number": "PT-001",
        "created_by_name": "John Doe",
        "documents": [
            {
                "can_show_in_portal": true,
                "file_name": "document.pdf",
                "file_type": "pdf",
                "file_size": 204800,
                "file_size_formatted": "200 KB",
                "document_id": 982000000567125,
                "attachment_order": 1
            }
        ],
        "custom_fields": [
            {
                "customfield_id": "46000000012845",
                "edit_on_store": "false",
                "show_in_all_pdf": "true",
                "search_entity": "contacts",
                "value": "Value123",
                "value_formatted": "Value123",
                "show_in_store": "false",
                "is_active": "true",
                "order": "1",
                "label": "Project Code",
                "api_name": "cf_project_code",
                "data_type": "text",
                "is_dependent_field": "false",
                "show_in_portal": "true",
                "show_on_pdf": "true",
                "edit_on_portal": "false"
            }
        ],
        "statuses": [
            "open",
            "closed",
            "pending"
        ],
        "is_system_task": false,
        "system_task_type": 2,
        "comments": [
            {
                "comment_id": 982000000567126,
                "description": "This is a sample comment.",
                "commented_by_id": 982000000567127,
                "commented_by": "Jane Doe",
                "comment_type": "internal",
                "date": "2025-01-01T12:00:00Z",
                "date_description": "One month ago",
                "time": "12:00 PM",
                "operation_type": "Added",
                "transaction_id": 982000000567128,
                "transaction_type": "invoice"
            }
        ],
        "dependencies": [
            {
                "dependency_id": 982000000567192,
                "dependency_type": 1,
                "depends_on_id": 982000000567193,
                "depends_on_entity_type": 20
            }
        ],
        "entity_tags": [
            {
                "id": 982000000567129,
                "name": "Important",
                "color": "FFB6C1"
            }
        ]
    }
}

Delete a tasks.
OAuth Scope : ZohoSubscriptions.settings.DELETE

Path Parameters

task_id

string

(Required)

Headers

X-com-zoho-subscriptions-organizationid

string

(Required)

ID of the organization

Request Example

headers_data = Map();
headers_data.put("X-com-zoho-subscriptions-organizationid", "10234695");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/billing/v3/tasks/982000000567114"
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/v3/tasks/982000000567114")
  .delete(null)
  .addHeader("X-com-zoho-subscriptions-organizationid", "10234695")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

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

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

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

import http.client

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

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

conn.request("DELETE", "/billing/v3/tasks/982000000567114", 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/v3/tasks/982000000567114",
  "headers": {
    "X-com-zoho-subscriptions-organizationid": "10234695",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

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

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

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

req.end();

curl --request DELETE \
  --url https://www.zohoapis.com/billing/v3/tasks/982000000567114 \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'X-com-zoho-subscriptions-organizationid: 10234695'

{
    "code": 0,
    "message": "Task deleted"
}

Update completed percentage of a task.
OAuth Scope : ZohoSubscriptions.settings.CREATE

Arguments

completion_percentage

integer

(Required)

Completion percentage of the task.

Path Parameters

task_id

string

(Required)

Headers

X-com-zoho-subscriptions-organizationid

string

(Required)

ID of the organization

Request Example

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

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

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

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

import http.client

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

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

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

conn.request("POST", "/billing/v3/tasks/982000000567114/percentage", 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/v3/tasks/982000000567114/percentage",
  "headers": {
    "X-com-zoho-subscriptions-organizationid": "10234695",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

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

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

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

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

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

{
    "completion_percentage": 75
}

{
    "code": 0,
    "message": "Task percentage updated",
    "task": {
        "task_id": 982000000567114,
        "recurring_task_id": 982000000567115,
        "owner_id": 982000000567116,
        "owner_ids": "982000000567116,982000000567117",
        "owner_name": "John Doe",
        "owners": [
            {
                "owner_id": 982000000567116,
                "owner_name": "John Doe",
                "owner_mail": "johndoe@example.com",
                "photo_url": "https://example.com/photo.jpg"
            }
        ],
        "title": "Sample Task",
        "due_date": "2025-12-31",
        "due_date_formatted": "31-12-2025",
        "is_overdue": true,
        "contact_type": "customer",
        "contact_id": 982000000567118,
        "color_code": "#FF5733",
        "contact_name": "Jane Smith",
        "parent_task_id": 982000000567119,
        "related_entity_id": 982000000567120,
        "related_entity_type": "invoice",
        "related_entity": 20,
        "related_entity_value": "INV-001",
        "parent_status": "open",
        "status": "open",
        "custom_status_id": 982000000567121,
        "billing_type": "based_on_task_hours",
        "is_billable": true,
        "task_rate": 50,
        "completion_percentage": 75,
        "is_subtask": false,
        "priority": "high",
        "reminder": {
            "remind_before": 2,
            "remind_at": "2025-12-29",
            "remind_at_formatted": "29-12-2025",
            "remind_type": "days",
            "remind_type_formatted": "Days",
            "alert_type": "email",
            "alert_type_formatted": "Email"
        },
        "task_description": "This is a sample task description.",
        "is_accountant_task": false,
        "task_number": "T-001",
        "task_number_prefix": "T-",
        "task_number_suffix": "-001",
        "can_push": true,
        "created_by_id": 982000000567122,
        "last_modified_by_id": 982000000567123,
        "template_id": 982000000567124,
        "due_after": 7,
        "parent_task_name": "Parent Task",
        "parent_task_number": "PT-001",
        "created_by_name": "John Doe",
        "documents": [
            {
                "can_show_in_portal": true,
                "file_name": "document.pdf",
                "file_type": "pdf",
                "file_size": 204800,
                "file_size_formatted": "200 KB",
                "document_id": 982000000567125,
                "attachment_order": 1
            }
        ],
        "custom_fields": [
            {
                "customfield_id": "46000000012845",
                "edit_on_store": "false",
                "show_in_all_pdf": "true",
                "search_entity": "contacts",
                "value": "Value123",
                "value_formatted": "Value123",
                "show_in_store": "false",
                "is_active": "true",
                "order": "1",
                "label": "Project Code",
                "api_name": "cf_project_code",
                "data_type": "text",
                "is_dependent_field": "false",
                "show_in_portal": "true",
                "show_on_pdf": "true",
                "edit_on_portal": "false"
            }
        ],
        "statuses": [
            "open",
            "closed",
            "pending"
        ],
        "is_system_task": false,
        "system_task_type": 2,
        "comments": [
            {
                "comment_id": 982000000567126,
                "description": "This is a sample comment.",
                "commented_by_id": 982000000567127,
                "commented_by": "Jane Doe",
                "comment_type": "internal",
                "date": "2025-01-01T12:00:00Z",
                "date_description": "One month ago",
                "time": "12:00 PM",
                "operation_type": "Added",
                "transaction_id": 982000000567128,
                "transaction_type": "invoice"
            }
        ],
        "dependencies": [
            {
                "dependency_id": 982000000567192,
                "dependency_type": 1,
                "depends_on_id": 982000000567193,
                "depends_on_entity_type": 20
            }
        ],
        "entity_tags": [
            {
                "id": 982000000567129,
                "name": "Important",
                "color": "FFB6C1"
            }
        ]
    }
}

Mark a task as open.
OAuth Scope : ZohoSubscriptions.settings.CREATE

Path Parameters

task_id

string

(Required)

Headers

X-com-zoho-subscriptions-organizationid

string

(Required)

ID of the organization

Request Example

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

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/billing/v3/tasks/982000000567114/markasopen")
  .post(null)
  .addHeader("X-com-zoho-subscriptions-organizationid", "10234695")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

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

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

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

import http.client

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

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

conn.request("POST", "/billing/v3/tasks/982000000567114/markasopen", headers=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/v3/tasks/982000000567114/markasopen",
  "headers": {
    "X-com-zoho-subscriptions-organizationid": "10234695",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

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

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

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

req.end();

curl --request POST \
  --url https://www.zohoapis.com/billing/v3/tasks/982000000567114/markasopen \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'X-com-zoho-subscriptions-organizationid: 10234695'

{
    "code": 0,
    "message": "Task status updated"
}

Mark a task as ongoing.
OAuth Scope : ZohoSubscriptions.settings.CREATE

Path Parameters

task_id

string

(Required)

Headers

X-com-zoho-subscriptions-organizationid

string

(Required)

ID of the organization

Request Example

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

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/billing/v3/tasks/982000000567114/markasongoing")
  .post(null)
  .addHeader("X-com-zoho-subscriptions-organizationid", "10234695")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

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

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

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

import http.client

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

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

conn.request("POST", "/billing/v3/tasks/982000000567114/markasongoing", headers=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/v3/tasks/982000000567114/markasongoing",
  "headers": {
    "X-com-zoho-subscriptions-organizationid": "10234695",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

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

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

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

req.end();

curl --request POST \
  --url https://www.zohoapis.com/billing/v3/tasks/982000000567114/markasongoing \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'X-com-zoho-subscriptions-organizationid: 10234695'

{
    "code": 0,
    "message": "Task status updated"
}

Mark a task as completed.
OAuth Scope : ZohoSubscriptions.settings.CREATE

Path Parameters

task_id

string

(Required)

Headers

X-com-zoho-subscriptions-organizationid

string

(Required)

ID of the organization

Request Example

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

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/billing/v3/tasks/982000000567114/markascompleted")
  .post(null)
  .addHeader("X-com-zoho-subscriptions-organizationid", "10234695")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

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

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

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

import http.client

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

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

conn.request("POST", "/billing/v3/tasks/982000000567114/markascompleted", headers=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/v3/tasks/982000000567114/markascompleted",
  "headers": {
    "X-com-zoho-subscriptions-organizationid": "10234695",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

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

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

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

req.end();

curl --request POST \
  --url https://www.zohoapis.com/billing/v3/tasks/982000000567114/markascompleted \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'X-com-zoho-subscriptions-organizationid: 10234695'

{
    "code": 0,
    "message": "Task status updated"
}

Add comment to task

Add comment to a task.
OAuth Scope : ZohoSubscriptions.settings.CREATE

Arguments

description

string

(Required)

Description of the comment.

Path Parameters

task_id

string

(Required)

Headers

X-com-zoho-subscriptions-organizationid

string

(Required)

ID of the organization

Request Example

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

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

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

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

import http.client

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

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

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

conn.request("POST", "/billing/v3/tasks/982000000567114/comments", 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/v3/tasks/982000000567114/comments",
  "headers": {
    "X-com-zoho-subscriptions-organizationid": "10234695",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

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

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

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

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

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

{
    "description": "This is a sample comment."
}

{
    "code": 0,
    "message": "Comments added",
    "comment": {
        "comment_id": 982000000567126,
        "description": "This is a sample comment.",
        "commented_by_id": 982000000567127,
        "commented_by": "Jane Doe",
        "comment_type": "internal",
        "date": "2025-01-01T12:00:00Z",
        "date_description": "One month ago",
        "time": "12:00 PM",
        "operation_type": "Added",
        "transaction_id": 982000000567128,
        "transaction_type": "invoice"
    }
}

List comments of task

List comments of a task.
OAuth Scope : ZohoSubscriptions.settings.READ

Path Parameters

task_id

string

(Required)

Headers

X-com-zoho-subscriptions-organizationid

string

(Required)

ID of the organization

Request Example

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

OkHttpClient client = new OkHttpClient();

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

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

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

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

import http.client

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

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

conn.request("GET", "/billing/v3/tasks/982000000567114/comments", headers=headers)

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

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

const http = require("https");

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

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

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

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

req.end();

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

{
    "code": 0,
    "message": "success",
    "comments": [
        {
            "comment_id": 982000000567126,
            "description": "This is a sample comment.",
            "commented_by_id": 982000000567127,
            "commented_by": "Jane Doe",
            "comment_type": "internal",
            "date": "2025-01-01T12:00:00Z",
            "date_description": "One month ago",
            "time": "12:00 PM",
            "operation_type": "Added",
            "transaction_id": 982000000567128,
            "transaction_type": "invoice"
        },
        {...},
        {...}
    ]
}

Delete comment of task

Delete a comment of a task.
OAuth Scope : ZohoSubscriptions.settings.DELETE

Path Parameters

task_id

string

(Required)

comment_id

string

(Required)

Headers

X-com-zoho-subscriptions-organizationid

string

(Required)

ID of the organization

Request Example

headers_data = Map();
headers_data.put("X-com-zoho-subscriptions-organizationid", "10234695");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/billing/v3/tasks/982000000567114/comments/982000000567116"
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/v3/tasks/982000000567114/comments/982000000567116")
  .delete(null)
  .addHeader("X-com-zoho-subscriptions-organizationid", "10234695")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

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

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

fetch('https://www.zohoapis.com/billing/v3/tasks/982000000567114/comments/982000000567116', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

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

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

conn.request("DELETE", "/billing/v3/tasks/982000000567114/comments/982000000567116", 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/v3/tasks/982000000567114/comments/982000000567116",
  "headers": {
    "X-com-zoho-subscriptions-organizationid": "10234695",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

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

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

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

req.end();

curl --request DELETE \
  --url https://www.zohoapis.com/billing/v3/tasks/982000000567114/comments/982000000567116 \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'X-com-zoho-subscriptions-organizationid: 10234695'

{
    "code": 0,
    "message": "Comments deleted"
}

Add attachment to a task.
OAuth Scope : ZohoSubscriptions.settings.CREATE

Path Parameters

task_id

string

(Required)

Query Parameters

attachment

binary

The file to be attached.Allowed Extensions: gif, png, jpeg, jpg, bmp, pdf, xls, xlsx, doc, docx, xml, csv, txt, tif and tiff

Headers

X-com-zoho-subscriptions-organizationid

string

(Required)

ID of the organization

Request Example

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

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/billing/v3/tasks/982000000567114/attachment")
  .post(null)
  .addHeader("X-com-zoho-subscriptions-organizationid", "10234695")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

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

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

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

import http.client

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

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

conn.request("POST", "/billing/v3/tasks/982000000567114/attachment", headers=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/v3/tasks/982000000567114/attachment",
  "headers": {
    "X-com-zoho-subscriptions-organizationid": "10234695",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

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

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

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

req.end();

curl --request POST \
  --url https://www.zohoapis.com/billing/v3/tasks/982000000567114/attachment \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'X-com-zoho-subscriptions-organizationid: 10234695'

{
    "code": 0,
    "message": "File uploaded",
    "documents": [
        {
            "can_show_in_portal": true,
            "file_name": "document.pdf",
            "file_type": "pdf",
            "file_size": 204800,
            "file_size_formatted": "200 KB",
            "document_id": 982000000567125,
            "attachment_order": 1
        },
        {...},
        {...}
    ]
}

Get a document of a task.
OAuth Scope : ZohoSubscriptions.settings.READ

Path Parameters

task_id

string

(Required)

document_id

string

(Required)

Query Parameters

image_size

string

Size of the image to be fetched. Allowed values are xlarge, large, small and tiny.

inline

boolean

Indicate whether the document should be displayed inline. Allowed values are true and false.

boolean

Indicates whether the document should be printed. Allowed values are true and false.

Headers

X-com-zoho-subscriptions-organizationid

string

(Required)

ID of the organization

Request Example

headers_data = Map();
headers_data.put("X-com-zoho-subscriptions-organizationid", "10234695");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/billing/v3/tasks/982000000567114/documents/982000000567118"
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/v3/tasks/982000000567114/documents/982000000567118")
  .get()
  .addHeader("X-com-zoho-subscriptions-organizationid", "10234695")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

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

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

fetch('https://www.zohoapis.com/billing/v3/tasks/982000000567114/documents/982000000567118', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

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

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

conn.request("GET", "/billing/v3/tasks/982000000567114/documents/982000000567118", 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/v3/tasks/982000000567114/documents/982000000567118",
  "headers": {
    "X-com-zoho-subscriptions-organizationid": "10234695",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

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

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

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

req.end();

curl --request GET \
  --url https://www.zohoapis.com/billing/v3/tasks/982000000567114/documents/982000000567118 \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'X-com-zoho-subscriptions-organizationid: 10234695'

{
    "code": 0,
    "message": "success",
    "documents": {
        "can_show_in_portal": true,
        "file_name": "document.pdf",
        "file_type": "pdf",
        "file_size": 204800,
        "file_size_formatted": "200 KB",
        "document_id": 982000000567125,
        "attachment_order": 1
    }
}

Delete a document of a task.
OAuth Scope : ZohoSubscriptions.settings.DELETE

Path Parameters

task_id

string

(Required)

document_id

string

(Required)

Query Parameters

un_associate

boolean

Indicates whether the document should be unassociated from the task. Allowed values are true and false.

Headers

X-com-zoho-subscriptions-organizationid

string

(Required)

ID of the organization

Request Example

headers_data = Map();
headers_data.put("X-com-zoho-subscriptions-organizationid", "10234695");
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/billing/v3/tasks/982000000567114/documents/982000000567118"
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/v3/tasks/982000000567114/documents/982000000567118")
  .delete(null)
  .addHeader("X-com-zoho-subscriptions-organizationid", "10234695")
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

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

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

fetch('https://www.zohoapis.com/billing/v3/tasks/982000000567114/documents/982000000567118', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

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

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

conn.request("DELETE", "/billing/v3/tasks/982000000567114/documents/982000000567118", 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/v3/tasks/982000000567114/documents/982000000567118",
  "headers": {
    "X-com-zoho-subscriptions-organizationid": "10234695",
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

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

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

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

req.end();

curl --request DELETE \
  --url https://www.zohoapis.com/billing/v3/tasks/982000000567114/documents/982000000567118 \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'X-com-zoho-subscriptions-organizationid: 10234695'

{
    "code": 0,
    "message": "Attachment deleted"
}

Attribute

Add a task

Arguments

Headers

Update tasks

Arguments

Query Parameters

Headers

List tasks

Query Parameters

Headers

Delete tasks

Query Parameters

Headers

Update a tasks

Arguments

Path Parameters

Headers

Get a task

Path Parameters

Headers

Delete a tasks

Path Parameters

Headers

Update completed percentage

Arguments

Path Parameters

Headers

Mark task as open

Path Parameters

Headers

Mark task as ongoing

Path Parameters

Headers

Mark task as completed

Path Parameters

Headers

Add comment to task

Arguments

Path Parameters

Headers

List comments of task

Path Parameters

Headers

Delete comment of task

Path Parameters

Headers

Add attachment to task

Path Parameters

Query Parameters

Headers

Get document of task

Path Parameters

Query Parameters

Headers

Delete document of task

Path Parameters

Query Parameters

Headers