Skip to content

/sales/comments

Path: /sales/comments
Namespace: sales
Resource: comments

Overview

The Comment resource in the sales namespace allows adding notes and annotations to sales-related resources such as invoices and addresses.

Key Difference from Admin: Sales namespace provides sales-focused access to comments for sales operations.

Relationships

See Admin Comments for complete relationship documentation. Sales comments use the same Comment model with sales-focused access.

Available Operations

List Comments (GET)

Endpoint: GET /sales/comments.json

Request Examples:

bash
curl -X GET "https://your-company.erpax.com/sales/comments.json" \
  -H "Accept: application/json" \
  -H "Cookie: session_cookie"

JavaScript Example:

javascript
const response = await fetch('/sales/comments.json', {
  credentials: 'include',
  headers: { 'Accept': 'application/json' }
});
const data = await response.json();

Show Comment (GET /:id)

Endpoint: GET /sales/comments/:id.json

Create Comment (POST)

Endpoint: POST /sales/comments.json

Update Comment (PATCH /:id)

Endpoint: PATCH /sales/comments/:id.json

Delete Comment (DELETE /:id)

Endpoint: DELETE /sales/comments/:id.json

Scopes

See Admin Comments for complete scope documentation.

Filters

See Admin Comments for complete filter documentation.

Business Rules

  • Authorization: If GET/POST/PATCH/DELETE /sales/comments returns 403 or 401, the signed-in user cannot perform that action in the sales workspace; use Admin Comments routes with an account that has access, or surface an error in your UI.
  • Payloads and filters: Match Admin Comments; only the path prefix changes to /sales/comments.

Released under an open source license.