<service domain|custom domain>/app/<portal>/api/v3/purchase_orders/{purchaseorder_id}/notes
Purchase Note
Use Purchase Order note to add additional information, including technical information, to a particular purchase order based on your observations.
Attributes
id (long)
Unique identifier to identify the note
description (html)
Contains the description of the note
notify_to (notify_to)
Contains the list of users to notify
attachments (attachment)
Indicates the attachments of the note.
performed_by (user)read only
Indicates the user who created the note
performed_time (datetime)read only
Indicates the created time of the note
Add Purchase Note
Use this operation to add a note
Mandatory Fields :- description
Url
Attributes
id (long)
Unique identifier to identify the note
description (html)
Contains the description of the note
summary (note_summary)
No Description
notify_to (notify_to)
Contains the list of users to notify
mentions (user)
No Description
attachments (attachment)
Indicates the attachments of the note.
More Attributes Expand all
$ curl <service domain|custom domain>/app/<portal>/api/v3/purchase_orders/{purchaseorder_id}/notes\
-X POST\
-H "Accept: application/vnd.manageengine.sdp.v3+json"\
-H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
-H "Content-Type: application/x-www-form-urlencoded"\
-d input_data='{
"note": {
"description": "Purchase Order Conversation Notes",
"notify_to": {
"users": [
{
"id": "2000000040351",
"name": "SDPCloud"
}
]
},
"attachments": [
{
"file_id": "3"
}
]
}
}'
// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/purchase_orders/{purchaseorder_id}/notes";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
"Content-Type": "application/x-www-form-urlencoded",
"Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
"note": {
"description": "Purchase Order Conversation Notes",
"notify_to": {
"users": [
{
"id": "2000000040351",
"name": "SDPCloud"
}
]
},
"attachments": [
{
"file_id": "3"
}
]
}
};
params = {"input_data": input_data};
response = invokeurl
[
url: url
type: POST
parameters: params
headers: headers
];
info response;
#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/purchase_orders/{purchaseorder_id}/notes"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
"Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
"Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
"note": {
"description": "Purchase Order Conversation Notes",
"notify_to": {
"users": [
{
"id": "2000000040351",
"name": "SDPCloud"
}
]
},
"attachments": [
{
"file_id": "3"
}
]
}
}
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method post -Body $data -Headers $headers
$response
#Python version - 3.10
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request
url = "<service domain|custom domain>/app/<portal>/api/v3/purchase_orders/{purchaseorder_id}/notes"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json",
"Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx",
"Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
"note": {
"description": "Purchase Order Conversation Notes",
"notify_to": {
"users": [
{
"id": "2000000040351",
"name": "SDPCloud"
}
]
},
"attachments": [
{
"file_id": "3"
}
]
}
}'''
data = urlencode({"input_data":input_data}).encode()
httprequest = Request(url, headers=headers,data=data, method="POST")
try:
with urlopen(httprequest) as response:
print(response.read().decode())
except HTTPError as e:
print(e.read().decode())
{
"note": {
"attachments": [
{
"size": "14842",
"content_type": "text/html",
"file_id": "7",
"name": "purchase.txt",
"content_url": "/purchase_orders/2000000040511/notes/2000000040537/_uploads/3",
"id": "2000000040549"
}
],
"performed_by": {
"email_id": "test@zylker.com",
"is_technician": true,
"sms_mail": null,
"mobile": null,
"last_name": "T8779",
"user_scope": "internal_user",
"sms_mail_id": null,
"cost_per_hour": "0",
"site": {
"deleted": false,
"name": "Base Site",
"id": "2000000006824",
"is_default": true
},
"phone": "",
"employee_id": null,
"name": "SDPCloud",
"id": "2000000040351",
"photo_url": "https://test-photo_url",
"is_vip_user": false,
"department": null,
"first_name": "Test",
"job_title": null
},
"description": "Purchase Order Conversation Notes",
"id": "2000000040537",
"performed_time": {
"display_value": "Jan 22, 2025 11:48 AM",
"value": "1737526736065"
}
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
Edit Purchase Note
Use this operation to edit a note
Url
<service domain|custom domain>/app/<portal>/api/v3/purchase_orders/{purchaseorder_id}/notes/{notes_id}
Attributes
id (long)
Unique identifier to identify the note
description (html)
Contains the description of the note
summary (note_summary)
No Description
notify_to (notify_to)
Contains the list of users to notify
mentions (user)
No Description
attachments (attachment)
Indicates the attachments of the note.
More Attributes Expand all
$ curl <service domain|custom domain>/app/<portal>/api/v3/purchase_orders/{purchaseorder_id}/notes/{notes_id}\
-X PUT\
-H "Accept: application/vnd.manageengine.sdp.v3+json"\
-H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
-H "Content-Type: application/x-www-form-urlencoded"\
-d input_data='{
"note": {
"description": "Purchase Order -Zykler"
}
}'
// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/purchase_orders/{purchaseorder_id}/notes/{notes_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
"Content-Type": "application/x-www-form-urlencoded",
"Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
"note": {
"description": "Purchase Order -Zykler"
}
};
params = {"input_data": input_data};
response = invokeurl
[
url: url
type: PUT
parameters: params
headers: headers
];
info response;
#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/purchase_orders/{purchaseorder_id}/notes/{notes_id}"
$headers = @{"Accept": "application/vnd.manageengine.sdp.v3+json",
"Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx",
"Content-Type" : "application/x-www-form-urlencoded"}
$input_data = @'
{
"note": {
"description": "Purchase Order -Zykler"
}
}
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method put -Body $data -Headers $headers
$response
#Python version - 3.10
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request
url = "<service domain|custom domain>/app/<portal>/api/v3/purchase_orders/{purchaseorder_id}/notes/{notes_id}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json",
"Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx",
"Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
"note": {
"description": "Purchase Order -Zykler"
}
}'''
data = urlencode({"input_data":input_data}).encode()
httprequest = Request(url, headers=headers,data=data, method="PUT")
try:
with urlopen(httprequest) as response:
print(response.read().decode())
except HTTPError as e:
print(e.read().decode())
{
"note": {
"attachments": [
{
"size": "14842",
"content_type": "text/html",
"file_id": "7",
"name": "purchase.txt",
"content_url": "/purchase_orders/2000000040511/notes/2000000040537/_uploads/7",
"id": "2000000040549"
}
],
"performed_by": {
"email_id": "test@zylker.com",
"is_technician": true,
"sms_mail": null,
"mobile": null,
"last_name": "T8779",
"user_scope": "internal_user",
"sms_mail_id": null,
"cost_per_hour": "0",
"site": {
"deleted": false,
"name": "Base Site",
"id": "2000000006824",
"is_default": true
},
"phone": "",
"employee_id": null,
"name": "SDPCloud",
"id": "2000000040351",
"photo_url": "https://test-photo_url",
"is_vip_user": false,
"department": null,
"first_name": "Test",
"job_title": null
},
"description": "Purchase Order Conversation Notes",
"id": "2000000040537",
"performed_time": {
"display_value": "Jan 22, 2025 11:48 AM",
"value": "1737526736065"
}
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
Get Purchase Note
Use this operation to get a note from a purchase order
Url
<service domain|custom domain>/app/<portal>/api/v3/purchase_orders/{purchaseorder_id}/notes/{notes_id}
Attributes
id (long)
Unique identifier to identify the note
description (html)
Contains the description of the note
summary (note_summary)
No Description
notify_to (notify_to)
Contains the list of users to notify
mentions (user)
No Description
attachments (attachment)
Indicates the attachments of the note.
More Attributes Expand all
$ curl -G <service domain|custom domain>/app/<portal>/api/v3/purchase_orders/{purchaseorder_id}/notes/{notes_id}\
-X GET\
-H "Accept: application/vnd.manageengine.sdp.v3+json"\
-H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
-H "Content-Type: application/x-www-form-urlencoded"
// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/purchase_orders/{purchaseorder_id}/notes/{notes_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
"Content-Type": "application/x-www-form-urlencoded",
"Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
response = invokeurl
[
url: url
type: GET
headers: headers
];
info response;
#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/purchase_orders/{purchaseorder_id}/notes/{notes_id}"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
"Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
"Content-Type" = "application/x-www-form-urlencoded"}
$response = Invoke-RestMethod -Uri $url -Method get -Headers $headers
$response
#Python version - 3.8
#This script requires requests module installed in python.
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request
url = "<service domain|custom domain>/app/<portal>/api/v3/purchase_orders/{purchaseorder_id}/notes/{notes_id}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json",
"Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx",
"Content-Type" : "application/x-www-form-urlencoded"}
httprequest = Request(url, headers=headers)
try:
with urlopen(httprequest) as response:
print(response.read().decode())
except HTTPError as e:
print(e.read().decode())
{
"note": {
"attachments": [
{
"size": "14842",
"content_type": "text/html",
"file_id": "7",
"name": "purchase.txt",
"content_url": "/purchase_orders/2000000040511/notes/2000000040537/_uploads/7",
"id": "2000000040549"
}
],
"performed_by": {
"email_id": "test@zylker.com",
"is_technician": true,
"sms_mail": null,
"mobile": null,
"last_name": "T8779",
"user_scope": "internal_user",
"sms_mail_id": null,
"cost_per_hour": "0",
"site": {
"deleted": false,
"name": "Base Site",
"id": "2000000006824",
"is_default": true
},
"phone": "",
"employee_id": null,
"name": "SDPCloud",
"id": "2000000040351",
"photo_url": "https://test-photo_url",
"is_vip_user": false,
"department": null,
"first_name": "Test",
"job_title": null
},
"description": "Purchase Order Conversation Notes",
"id": "2000000040537",
"performed_time": {
"display_value": "Jan 22, 2025 11:48 AM",
"value": "1737526736065"
}
},
"response_status": {
"status_code": 2000,
"status": "success"
}
}
Get List Purchase Note
Use this operation to get a list of all notes
Url
<service domain|custom domain>/app/<portal>/api/v3/purchase_orders/{purchaseorder_id}/notes
Attributes
id (long)
Unique identifier to identify the note
description (html)
Contains the description of the note
summary (note_summary)
No Description
notify_to (notify_to)
Contains the list of users to notify
mentions (user)
No Description
attachments (attachment)
Indicates the attachments of the note.
More Attributes Expand all
$ curl -G <service domain|custom domain>/app/<portal>/api/v3/purchase_orders/{purchaseorder_id}/notes\
-X GET\
-H "Accept: application/vnd.manageengine.sdp.v3+json"\
-H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
-H "Content-Type: application/x-www-form-urlencoded"\
--data-urlencode input_data=''
// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/purchase_orders/{purchaseorder_id}/notes";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
"Content-Type": "application/x-www-form-urlencoded",
"Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = ;
params = {"input_data":input_data};
response = invokeurl
[
url: url
type: GET
parameters:params
headers: headers
];
info response;
#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/purchase_orders/{purchaseorder_id}/notes"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
"Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
"Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @''@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method get -Body $data -Headers $headers
$response
#Python version - 3.8
#This script requires requests module installed in python.
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request
url = "<service domain|custom domain>/app/<portal>/api/v3/purchase_orders/{purchaseorder_id}/notes"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json",
"Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx",
"Content-Type" : "application/x-www-form-urlencoded"}
input_data = ''''''
url += "?" + urlencode({"input_data":input_data})
httprequest = Request(url, headers=headers)
try:
with urlopen(httprequest) as response:
print(response.read().decode())
except HTTPError as e:
print(e.read().decode())
{
"notes": [
{
"performed_by": {
"email_id": "test@zylker.com",
"is_technician": true,
"sms_mail": null,
"mobile": null,
"last_name": "T8779",
"user_scope": "internal_user",
"sms_mail_id": null,
"cost_per_hour": "0",
"site": {
"deleted": false,
"name": "Base Site",
"id": "2000000006824",
"is_default": true
},
"phone": "",
"employee_id": null,
"name": "SDPCloud",
"id": "2000000040351",
"photo_url": "https://test-photo_url",
"is_vip_user": false,
"department": null,
"first_name": "Test",
"job_title": null
},
"description": "Purchase Order Conversation Notes",
"id": "2000000040523",
"performed_time": {
"display_value": "Jan 22, 2025 11:46 AM",
"value": "1737526612426"
}
},
{
"performed_by": {
"email_id": "test@zylker.com",
"is_technician": true,
"sms_mail": null,
"mobile": null,
"last_name": "T8779",
"user_scope": "internal_user",
"sms_mail_id": null,
"cost_per_hour": "0",
"site": {
"deleted": false,
"name": "Base Site",
"id": "2000000006824",
"is_default": true
},
"phone": "",
"employee_id": null,
"name": "SDPCloud",
"id": "2000000040351",
"photo_url": "https://test-photo_url",
"is_vip_user": false,
"department": null,
"first_name": "Test",
"job_title": null
},
"description": "Payment is due within 30 days of the invoice date. Late payments will incur a penalty of 2% per month.",
"id": "2000000040537",
"performed_time": {
"display_value": "Jan 22, 2025 11:48 AM",
"value": "1737526736065"
}
}
],
"response_status": [
{
"status_code": 2000,
"status": "success"
}
],
"list_info": {
"has_more_rows": false,
"row_count": 2
}
}
Delete Purchase Note
Use this operation to delete a note from a purchase order
Url
<service domain|custom domain>/app/<portal>/api/v3/purchase_orders/{purchaseorder_id}/notes/{notes_id}
$ curl <service domain|custom domain>/app/<portal>/api/v3/purchase_orders/{purchaseorder_id}/notes/{notes_id}\
-X DELETE\
-H "Accept: application/vnd.manageengine.sdp.v3+json"\
-H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
-H "Content-Type: application/x-www-form-urlencoded"
// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/purchase_orders/{purchaseorder_id}/notes/{notes_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
"Content-Type": "application/x-www-form-urlencoded",
"Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
response = invokeurl
[
url: url
type: DELETE
headers: headers
];
info response;
#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/purchase_orders/{purchaseorder_id}/notes/{notes_id}"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
"Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
"Content-Type" = "application/x-www-form-urlencoded"}
$response = Invoke-RestMethod -Uri $url -Method delete -Headers $headers
$response
#Python version - 3.10
from urllib.error import HTTPError
from urllib.request import urlopen,Request
url = "<service domain|custom domain>/app/<portal>/api/v3/purchase_orders/{purchaseorder_id}/notes/{notes_id}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json",
"Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx",
"Content-Type" : "application/x-www-form-urlencoded"}
httprequest = Request(url, headers=headers,method="DELETE")
try:
with urlopen(httprequest) as response:
print(response.read().decode())
except HTTPError as e:
print(e.read().decode())
{
"response_status": {
"status_code": 2000,
"status": "success"
}
}