Comment
A note written on any record, shown on its page in the back office.
Area: Your app: its install, its user and its doors · Why it is here: openapi.yaml; recipe merge_documents; the MCP server; the request collection · Fields: 11
Read and write it
Every call runs as your app's own user, with its key in one header, at the retailer's own address. The user reads and writes only what its role allows: your app's user, and the rights the retailer gives it.
Read a list (only name unless you ask for fields):
curl -s "https://⟨site⟩/api/resource/Comment?fields=%5B%22*%22%5D&limit_page_length=20" \
-H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Read one:
curl -s "https://⟨site⟩/api/resource/Comment/⟨name⟩" -H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Create one (the required fields first), if your app's role may:
curl -s -X POST "https://⟨site⟩/api/resource/Comment" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
-H "Content-Type: application/json" -d '{"comment_type": …}'
Change one with PUT /api/resource/Comment/⟨name⟩ and the fields you change; a table sent there replaces its rows, so send its existing rows too. All the record calls and their answers: the API reference.
Samples that use it
s1_warranty · s28_merge_and_history · s49_post_sale_feedback
Fields
Read from the product at POS 2.1.0.667 (till app 60147699c): its own fields, the fields iVendNext adds to it, and iVendNext's changes to any of them. Read-only fields are set by iVendNext; a hidden one is not on the form but can be read. Every record also has name (its id, in the address), owner, creation, modified, modified_by and docstatus (0 a draft, 1 submitted, 2 cancelled), all read-only.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| Comment Type | comment_type |
Select | yes | one of: Comment, Like, Info, Label, Workflow, Created, Submitted, Cancelled, Updated, Deleted, Assigned, Assignment Completed … | ||
| Comment Email | comment_email |
Data | ||||
| Subject | subject |
Text | ||||
| Comment By | comment_by |
Data | ||||
| Published | published |
Check | ||||
| Seen | seen |
Check | ||||
| Reference Document Type | reference_doctype |
Link | DocType | |||
| Reference Name | reference_name |
Dynamic Link | ||||
| Reference Owner | reference_owner |
Data | yes | |||
| Content | content |
HTML Editor | ||||
| IP Address | ip_address |
Data | yes |