Add a comment to a customer invoice

Add a comment to a customer invoice. The comment appears in the
Comments section of the invoice in Pennylane, authored by the user
who granted the access token. Access tokens that are not issued to a
user are rejected with a 403.

The content is stored as plain text. Mentions and rich text are not
supported. A content made only of Unicode whitespace, such as no-break
spaces, is rejected with a 422.

This request is not idempotent: each call adds a new comment, so
retrying after a timeout can create a duplicate.

ℹ️

This endpoint requires the following scope: customer_invoices:all

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.

Body Params
string
required
length ≤ 10000
(?=^[^\x00]*$)(?=\S)

Plain text of the comment. Must contain at least one non-whitespace character.

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.

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