API Reference

List comments of a customer invoice

get
https://app.pennylane.com/api/external/v2/customer_invoices//comments

List the comments of a customer invoice, newest first. These are the
comments shown in the Comments section of the invoice in Pennylane.

Mentions of users are rendered as @First name Last name.
Listing comments does not mark them as read.

ℹ️

This endpoint requires one of the following scopes: customer_invoices:all, customer_invoices:readonly

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

The unique identifier of the customer invoice.

Query Params
string

Cursor for pagination. Use this to fetch the next set of results.
The cursor is an opaque string returned in the previous response's metadata.
Leave empty for the first request.

integer
1 to 100

Number of items to return per request.
Defaults to 20 if not specified.
Must be between 1 and 100.

string
Defaults to -created_at

You can choose to sort items on specific attributes
Sort field may be prefixed with - for descending order. By default uses created_at in descending order.
Example : created_at will sort by ascending order, -created_at will sort by descending order.
Keep the same value when you request the next pages with the cursor.
Available fields :

  • created_at
Headers
string

Numeric ID of the company to act on. Required when authenticating with a firm token. Ignored when the token is already bound to a company.

Responses

414

URI Too Long: the request URL exceeds the maximum length. Shorten the query string, for example by sending fewer values per query parameter and splitting them across several requests.

Updated about 4 hours ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 4 hours ago