Sign in

v2

latestOpenAPI 3.0.42026-08-084694591.6 MB
Note

Find notes based on search parameters.

post/api/notes/list

Request body

parentType'salesOrder' | 'purchaseOrder' | 'quote' | 'invoice' required

Note parent document type

parentIdstring required

Filter notes by parent Id. Either 24 or 36 characters, depending on parent type

Response

List of notes matching the filters

idstring required

Unique id associated to this entity.

parentIdstring nullable

Unique identifier of the object to which the note is attached Can be 24 or 36 characters, depending on parent type

parentType'salesOrder' | 'purchaseOrder' | 'quote' | 'invoice'

Note parent document type

bodystring nullable

Note text

mentionsstring[] nullable

User Ids to tag in the note. Please reference /api/users endpoints.