Invoice Comments API
curl --request GET \
--url https://api.pazy.io/v1.0/invoice/:id/commentsimport requests
url = "https://api.pazy.io/v1.0/invoice/:id/comments"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.pazy.io/v1.0/invoice/:id/comments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.pazy.io/v1.0/invoice/:id/comments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.pazy.io/v1.0/invoice/:id/comments"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.pazy.io/v1.0/invoice/:id/comments")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pazy.io/v1.0/invoice/:id/comments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyInvoice APIs
Invoice Comments API
Retrieve all comments about a specific invoice by its identifier
Invoice Comments API
curl --request GET \
--url https://api.pazy.io/v1.0/invoice/:id/commentsimport requests
url = "https://api.pazy.io/v1.0/invoice/:id/comments"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.pazy.io/v1.0/invoice/:id/comments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.pazy.io/v1.0/invoice/:id/comments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.pazy.io/v1.0/invoice/:id/comments"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.pazy.io/v1.0/invoice/:id/comments")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pazy.io/v1.0/invoice/:id/comments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyAuthentication
All requests require an API key in the request headers. Headers:Authorization: Api-Key YOUR_API_KEY
Request
Content-Type:application/json
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The unique identifier of the invoice to retrieve |
Code Examples
curl -X GET https://api.pazy.io/v1.0/invoice/invoice_identifier/comments \
-H "Authorization: Api-Key YOUR_API_KEY"
const response = await fetch(
"https://api.pazy.io/v1.0/invoice/invoice_identifier/comments",
{
method: "GET",
headers: {
Authorization: "Api-Key YOUR_API_KEY",
},
},
);
const result = await response.json();
import requests
url = "https://api.pazy.io/v1.0/invoice/invoice_identifier/comments"
headers = {
"Authorization": "Api-Key YOUR_API_KEY"
}
response = requests.get(url, headers=headers)
result = response.json()
Success Response
HTTP Status:200 OK
Response Fields:
| Field | Type | Description |
|---|---|---|
ok | boolean | Indicates whether the request was successful |
data | object | Contains the invoice comments response data |
data.comments | array | List of comments associated with the invoice |
data.comments[].content | string | The content of the comment |
data.comments[].type | string | The type of the comment. It is one of five values: GENERAL, DECLINE, APPROVAL, REMARKS, FLAG |
data.comments[].dateCreated | string | Date when the comment was created (ISO 8601 format) |
data.comments[].user | object | Information about the user who made the comment |
data.comments[].user.id | string | Unique identifier for the user |
data.comments[].user.name | string | Name of the user |
data.context | object | Additional context for the comments |
data.context.count | number | The total number of comments |
Response Example
{
"ok": true,
"data": {
"comments": [
{
"content": "@Jane Smith Hello Hi testing @John Q",
"type": "GENERAL",
"dateCreated": "2026-03-28T09:11:30.293Z",
"user": {
"id": "<userId>",
"name": "John Doe"
}
},
{
"content": "Hello",
"type": "GENERAL",
"dateCreated": "2026-03-28T08:54:42.476Z",
"user": {
"id": "<userId>",
"name": "John Doe"
}
},
{
"content": "@Jane Smith @John Q Testing",
"type": "GENERAL",
"dateCreated": "2026-03-28T08:52:28.625Z",
"user": {
"id": "<userId>",
"name": "John Doe"
}
},
{
"content": "@Jane Smith Hi",
"type": "GENERAL",
"dateCreated": "2026-03-28T08:50:15.571Z",
"user": {
"id": "<userId>",
"name": "John Doe"
}
}
],
"context": {
"count": 4
}
}
}
Error Responses
Missing Invoice ID
HTTP Status:400 Bad Request
{
"ok": false,
"error": {
"code": "MISSING_REQUIRED_FIELD",
"message": "Invoice ID is required"
}
}
Invoice Not Found
HTTP Status:404 Not Found
{
"ok": false,
"error": {
"code": "INVOICE_NOT_FOUND",
"message": "Invoice not found"
}
}
Access Denied
HTTP Status:403 Forbidden
{
"ok": false,
"error": {
"code": "ACCESS_DENIED",
"message": "Access denied: You can only view your own invoices or invoices where you are the vendor owner"
}
}
Authentication Errors
HTTP Status:401 Unauthorized
{
"ok": false,
"error": {
"code": "MISSING_CREDENTIALS",
"message": "Missing Credentials"
}
}
{
"ok": false,
"error": {
"code": "INVALID_API_KEY",
"message": "Invalid API Key"
}
}
Permission Errors
HTTP Status:403 Forbidden
{
"ok": false,
"error": {
"code": "INSUFFICIENT_PERMISSIONS",
"message": "Permission check failed - PERMISSION_CHECK_FAILED"
}
}
Best Practices
Access Control
- Only invoices you created or where you are the vendor owner are accessible (unless you have admin or auditor role)
- Use the invoice
idreturned from the invoice creation endpoint to retrieve comments
Was this page helpful?