API documentation
User
Tenant
Feature
Entitlement
User & permissions
Settings
- Settings
- Media
- Webhook
- Notification
Payment
- Payment Method
- Transaction
- SEPA XML
- Open Banking
- Bank Account Transaction
Customer
- Customer
- Customer Address
- Customer Email
- Customer Settings
- Customer Otp
Billing
- Invoice
- GETGet invoices
- POSTCreate draft invoice
- GETGet invoice
- PUTUpdate draft invoice
- DELDelete invoice
- POSTCancel invoice
- POSTCredit invoice
- POSTSet invoice customer address
- PUTToggle dunning
- POSTDuplicate invoice
- POSTFinalize invoice
- PUTSet invoice note
- POSTSet invoice payment method
- POSTAdd invoice payment
- POSTAdd invoice position items
- GETGet invoice preview
- PUTResend invoice
- PUTGet invoice download link
- PUTClose invoice
- POSTAdd comment
- GET
- Invoice Position Item
- Billing Run
Dunning
- Dunning Document
- Dunning Rule
Subscription
- Subscription
- Subscription Item
- Subscription Measurement
- Billing Group
Offers
- Offer
- Offer Recipient
- Offer Template
Catalogue
- Unit
- Measurement
- Product
- Product Family
- Price Plan
- Coupon
Checkout
- Checkout Link
- Cart
Accounting
Invoice
Add comment
Add comment. This is available for invoices, credit notes and cancellations.
Required permissions:invoice:write
POST
/
invoices
/
{id}
/
comment
curl -X POST \
/invoices/{id}/comment \
--header "Content-Type: application/json" \
--header "Authorization: Bearer <token>" \
--data '{
"comment": ""
}'
{
"id": "<string>",
"dateTime": "2023-11-07T05:31:56Z",
"type": "commented",
"user": {
"user": {
"firstName": "John",
"lastName": "Doe",
"email": "jsmith@example.com"
},
"deactivated": true,
"avatar": "<string>",
"fullName": "<string>",
"initial": "<string>",
"gravatarUrl": "<string>"
},
"metadata": {},
"pinned": true
}
Authorizations
Value for the Authorization header parameter.
Path Parameters
Invoice identifier
Body
The new Invoice resource
Response
201
application/json
Invoice resource created
Was this page helpful?
curl -X POST \
/invoices/{id}/comment \
--header "Content-Type: application/json" \
--header "Authorization: Bearer <token>" \
--data '{
"comment": ""
}'
{
"id": "<string>",
"dateTime": "2023-11-07T05:31:56Z",
"type": "commented",
"user": {
"user": {
"firstName": "John",
"lastName": "Doe",
"email": "jsmith@example.com"
},
"deactivated": true,
"avatar": "<string>",
"fullName": "<string>",
"initial": "<string>",
"gravatarUrl": "<string>"
},
"metadata": {},
"pinned": true
}
Assistant
Responses are generated using AI and may contain mistakes.