Comments

sales Invoice Management V1Get Comments List Get

get

Lists comments for a specified invoice.

Path parameters

idstringRequired

(Required) The invoice ID.

Example: <integer>

Responses

200

OK

application/json

Responseobject

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

HTTPcURLJavaScriptPython

GET /V1/invoices/{id}/comments HTTP/1.1
Host: {{baseurl}}
Accept: */*

{
  "items": [
    {
      "is_customer_notified": -80169374,
      "parent_id": 21862377,
      "comment": "nisi laborum dolore nostrud",
      "is_visible_on_front": -41255087,
      "extension_attributes": {},
      "created_at": "et",
      "entity_id": 44488953
    },
    {
      "is_customer_notified": -46596682,
      "parent_id": -38745062,
      "comment": "eu dolor eiusmod",
      "is_visible_on_front": -39225279,
      "extension_attributes": {},
      "created_at": "nisi",
      "entity_id": 23230737
    }
  ],
  "search_criteria": {
    "filter_groups": [
      {
        "filters": [
          {
            "field": "sed adipisicing dolore amet",
            "value": "minim magna",
            "condition_type": "proident"
          },
          {
            "field": "cupidatat amet et",
            "value": "mollit eiusmod dolore",
            "condition_type": "ullamco deserunt sint"
          }
        ]
      },
      {
        "filters": [
          {
            "field": "cillum do",
            "value": "sit laborum voluptate",
            "condition_type": "enim ipsum incididunt dolor"
          },
          {
            "field": "dolor labore",
            "value": "laboris irure proident in consectetur",
            "condition_type": "Lorem sunt occaecat eu consect"
          }
        ]
      }
    ],
    "sort_orders": [
      {
        "field": "Ut",
        "direction": "Excepteur amet mollit"
      },
      {
        "field": "Lorem dolor",
        "direction": "esse minim"
      }
    ],
    "page_size": 61250444,
    "current_page": -88188090
  },
  "total_count": -37447955
}

sales Invoice Comment Repository V1Save Post

post

Performs persist operations for a specified invoice comment.

Header parameters

Content-TypestringOptionalExample: application/json

Body

objectOptionalExample: {"entity":{"is_customer_notified":-29641042,"parent_id":49280475,"comment":"anim quis amet","is_visible_on_front":-2568422,"extension_attributes":{},"created_at":"veniam dolor cillum","entity_id":97691540}}

Responses

200

OK

application/json

Responseobject

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

post

HTTPcURLJavaScriptPython

POST /V1/invoices/comments HTTP/1.1
Host: {{baseurl}}
Content-Type: application/json
Accept: */*
Content-Length: 206

{
  "entity": {
    "is_customer_notified": -29641042,
    "parent_id": 49280475,
    "comment": "anim quis amet",
    "is_visible_on_front": -2568422,
    "extension_attributes": {},
    "created_at": "veniam dolor cillum",
    "entity_id": 97691540
  }
}

{
  "is_customer_notified": 66734434,
  "parent_id": 68782394,
  "comment": "irure et incididunt",
  "is_visible_on_front": 46725532,
  "extension_attributes": {},
  "created_at": "dolore dolor ea cupidatat est",
  "entity_id": -8724128
}