Create | Mercoa | Documentation

from mercoa import Mercoa
from mercoa.invoice_types import CommentRequest
client = Mercoa(
    token="YOUR_TOKEN",
)
client.invoice.comment.create(
    invoice_id="in_3d61faa9-1754-4b7b-9fcb-88ff97f368ff",
    request=CommentRequest(
        text="This is a comment",
        user_id="user_e24fc81c-c5ee-47e8-af42-4fe29d895506",
    ),
)

{
  "id": "ic_b3525b66-da94-4525-9f31-426bcf657128",
  "text": "This is a comment",
  "createdAt": "2021-01-01T00:00:00Z",
  "updatedAt": "2021-01-01T00:00:00Z",
  "user": {
    "id": "user_ec3aafc8-ea86-408a-a6c1-545497badbbb",
    "roles": [
      "admin",
      "approver"
    ],
    "createdAt": "2024-01-01T00:00:00Z",
    "updatedAt": "2024-01-01T00:00:00Z",
    "foreignId": "MY-DB-ID-12345",
    "email": "john.doe@acme.com",
    "name": "John Doe"
  }
}

Add a comment to this invoice

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

invoiceIdstringRequired

Invoice ID or Invoice ForeignID

Request

This endpoint expects an object.

textstringRequired

userIdstringOptional

The ID or the Foreign ID of the user who created the comment.

Response

This endpoint returns an object.

idstring

textstring

createdAtdatetime

updatedAtdatetime

userobject

associatedApprovalActionobject

If an approval action has triggered the generation of this comment, returns the associated approval action and actor

Errors

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

500

Internal Server Error

501

Unimplemented