Get comments

Gets comments for a Notes object.

Note: The Collections Window, Notes, Advanced Payment Manager, Payment Plans, and Statement Generator features are entering end of support on June 3, 2024. For more information, please refer to the Product and Feature End of Support page.

Request
query Parameters
notesId
required
string

The ID of the Notes object. It is an account number (32-digit hex) for Accounts object type, and an invoice number for Invoices object type.

Example: notesId=2c92c0f866a9a8fe0166bd04878b2867
notesParentId
required
string

The ID of the parent object. For Accounts object type, the notesParentId is an account name.

Example: notesParentId=Account Name Example
object
required
string

The object type. The value can be "Accounts" or "Invoices" for Collections Window.

Example: object=Accounts
start_date
string

The start date of the period within which the comments are exported.

Example: start_date=2020-12-01
end_date
string

The end date of the period within which the comments are exported.

Example: end_date=2020-12-31
header Parameters
API-Token
required
string

The API token that is shown in the settings of Notes. It is a 64-digit hex number.

Example: a48865e51c3f4610de8f319bdd7bf691b2aaad827ed31ad1dd6847e617200666
Responses
200
get/api/v1/notes/comments?notesId={notesId}&notesParentId={notesParentId}&object={object}
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "data": {
    },
  • "pagination": {
    }
}