Performs persist operations for a specified invoice comment

POST /V1/invoices/comments

Performs persist operations for a specified invoice comment.

Body

entity object Required

Invoice comment interface. An invoice is a record of the receipt of payment for an order. An invoice can include comments that detail the invoice history.
Hide entity attributes Show entity attributes object
- is_customer_notified integer Required
  
  Is-customer-notified flag value.
- parent_id integer Required
  
  Parent ID.
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Sales\Api\Data\InvoiceCommentInterface
- comment string Required
  
  Comment.
- is_visible_on_front integer Required
  
  Is-visible-on-storefront flag value.
- created_at string
  
  Created-at timestamp.
- entity_id integer
  
  Invoice ID.

Body

entity object Required

Invoice comment interface. An invoice is a record of the receipt of payment for an order. An invoice can include comments that detail the invoice history.
Hide entity attributes Show entity attributes object
- is_customer_notified integer Required
  
  Is-customer-notified flag value.
- parent_id integer Required
  
  Parent ID.
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Sales\Api\Data\InvoiceCommentInterface
- comment string Required
  
  Comment.
- is_visible_on_front integer Required
  
  Is-visible-on-storefront flag value.
- created_at string
  
  Created-at timestamp.
- entity_id integer
  
  Invoice ID.

Responses

200

application/json

application/json application/xml

200 Success.
Hide response attributes Show response attributes object
- is_customer_notified integer Required
  
  Is-customer-notified flag value.
- parent_id integer Required
  
  Parent ID.
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Sales\Api\Data\InvoiceCommentInterface
- comment string Required
  
  Comment.
- is_visible_on_front integer Required
  
  Is-visible-on-storefront flag value.
- created_at string
  
  Created-at timestamp.
- entity_id integer
  
  Invoice ID.
Hide response attributes Show response attributes object
- is_customer_notified integer Required
  
  Is-customer-notified flag value.
- parent_id integer Required
  
  Parent ID.
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\Sales\Api\Data\InvoiceCommentInterface
- comment string Required
  
  Comment.
- is_visible_on_front integer Required
  
  Is-visible-on-storefront flag value.
- created_at string
  
  Created-at timestamp.
- entity_id integer
  
  Invoice ID.
401

application/json

application/json application/xml

401 Unauthorized
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
400

application/json

application/json application/xml

400 Bad Request
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
default

application/json

application/json application/xml

Unexpected error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Errors list
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters list
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace

POST /V1/invoices/comments

curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/invoices/comments' \
 --header "Content-Type: application/json" \
 --data '{"entity":{"is_customer_notified":42,"parent_id":42,"extension_attributes":{},"comment":"string","is_visible_on_front":42,"created_at":"string","entity_id":42}}'

curl \
 --request POST 'https://magento2.winkelstraat.mac/rest/all/V1/invoices/comments' \
 --header "Content-Type: application/xml"

Request examples

{
  "entity": {
    "is_customer_notified": 42,
    "parent_id": 42,
    "extension_attributes": {},
    "comment": "string",
    "is_visible_on_front": 42,
    "created_at": "string",
    "entity_id": 42
  }
}

Request examples

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <entity>
    <is-customer-notified type="integer">42</is-customer-notified>
    <parent-id type="integer">42</parent-id>
    <extension-attributes>
    </extension-attributes>
    <comment>string</comment>
    <is-visible-on-front type="integer">42</is-visible-on-front>
    <created-at>string</created-at>
    <entity-id type="integer">42</entity-id>
  </entity>
</root>

Response examples (200)

{
  "is_customer_notified": 42,
  "parent_id": 42,
  "extension_attributes": {},
  "comment": "string",
  "is_visible_on_front": 42,
  "created_at": "string",
  "entity_id": 42
}

Response examples (200)

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <is-customer-notified type="integer">42</is-customer-notified>
  <parent-id type="integer">42</parent-id>
  <extension-attributes>
  </extension-attributes>
  <comment>string</comment>
  <is-visible-on-front type="integer">42</is-visible-on-front>
  <created-at>string</created-at>
  <entity-id type="integer">42</entity-id>
</root>

Response examples (401)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Response examples (401)

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>

Response examples (400)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Response examples (400)

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>

Response examples (default)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Response examples (default)

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>