Add notes and/or tags to an invoice without changing its approval or rejection status.
Use this when you need to attach metadata to an invoice without triggering an approve/reject workflow action. Previously, adding notes or tags required sending an unReject or unApprove action.
Request Fields
| Field | Type | Description |
|---|---|---|
| notes | string | Notes to add. Stored as a communication entry with the acting user's ID and timestamp. |
| tags | string | Comma-separated tags to apply to the invoice. |
At least one field should be provided. If neither is provided, the response indicates no annotation was added.
Enter your API token.
The invoice ID to annotate.
Add Notes and Tags
{
"notes": "Verified line items against PO",
"tags": "verified,q1-2024"
}Tags Only
{
"tags": "reviewed"
}Notes Only
{
"notes": "Forwarded to accounting for review"
}Request body for invoice actions (annotate, approve, reject, unApprove, unReject). Both fields are optional.
Notes to add to the invoice. Stored as a communication entry with the acting user's ID and timestamp.
Comma-separated tags to apply to the invoice.
Annotation applied
Annotation Added
{
"status": "OK",
"msg": "Annotation added.",
"result": 12345
}No Annotation Provided
{
"status": "OK",
"msg": "No annotation to add.",
"result": 12345
}Bad Request
Invoice Group Not Actionable
{
"status": "Error",
"msg": "ID is of an invoice group and is not actionable.",
"result": null
}Unauthorized - Missing or invalid API token
Invoice not found
Not Found
{
"status": "Error",
"msg": "Record not found.",
"result": null
}