CreditmemoCommentInterface Interface Reference

Inheritance diagram for CreditmemoCommentInterface:

Public Member Functions
	getComment ()
	getCreatedAt ()
	setCreatedAt ($createdAt)
	getEntityId ()
	setEntityId ($entityId)
	getIsCustomerNotified ()
	getIsVisibleOnFront ()
	getParentId ()
	setParentId ($id)
	setIsCustomerNotified ($isCustomerNotified)
	setIsVisibleOnFront ($isVisibleOnFront)
	setComment ($comment)
	getExtensionAttributes ()
	setExtensionAttributes (\Magento\Sales\Api\Data\CreditmemoCommentExtensionInterface $extensionAttributes)

Data Fields
const	ENTITY_ID = 'entity_id'
const	PARENT_ID = 'parent_id'
const	IS_CUSTOMER_NOTIFIED = 'is_customer_notified'
const	IS_VISIBLE_ON_FRONT = 'is_visible_on_front'
const	COMMENT = 'comment'
const	CREATED_AT = 'created_at'
Data Fields inherited from ExtensibleDataInterface
const	EXTENSION_ATTRIBUTES_KEY = 'extension_attributes'

Detailed Description

Credit memo comment interface.

After a customer places and pays for an order and an invoice has been issued, the merchant can create a credit memo to refund all or part of the amount paid for any returned or undelivered items. The memo restores funds to the customer account so that the customer can make future purchases. A credit memo usually includes comments that detail why the credit memo amount was credited to the customer. @api

Since

100.0.2

Definition at line 18 of file CreditmemoCommentInterface.php.

Member Function Documentation

getComment()

getComment

(

)

Gets the credit memo comment.

Returns

string Comment.

Implemented in Comment.

getCreatedAt()

getCreatedAt

(

)

Gets the credit memo created-at timestamp.

Returns

string|null Created-at timestamp.

Implemented in Comment.

getEntityId()

getEntityId

(

)

Gets the credit memo ID.

Returns

int|null Credit memo ID.

getExtensionAttributes()

getExtensionAttributes

(

)

Retrieve existing extension attributes object or create a new one.

Returns

\Magento\Sales\Api\Data\CreditmemoCommentExtensionInterface|null

Implemented in Comment.

getIsCustomerNotified()

getIsCustomerNotified

(

)

Gets the is-customer-notified flag value for the credit memo.

Returns

int Is-customer-notified flag value.

Implemented in Comment.

getIsVisibleOnFront()

getIsVisibleOnFront

(

)

Gets the is-visible-on-storefront flag value for the credit memo.

Returns

int Is-visible-on-storefront flag value.

Implemented in Comment.

getParentId()

getParentId

(

)

Gets the parent ID for the credit memo.

Returns

int Parent ID.

Implemented in Comment.

setComment()

setComment

(

$comment

)

Sets the credit memo comment.

Parameters

string

$comment

Returns

$this

Implemented in Comment.

setCreatedAt()

setCreatedAt

(

$createdAt

)

Sets the credit memo created-at timestamp.

Parameters

string

$createdAt

timestamp

Returns

$this

Implemented in Comment.

setEntityId()

setEntityId

(

$entityId

)

Sets entity ID.

Parameters

int

$entityId

Returns

$this

setExtensionAttributes()

setExtensionAttributes

(

\Magento\Sales\Api\Data\CreditmemoCommentExtensionInterface

$extensionAttributes

)

Set an extension attributes object.

Parameters

\Magento\Sales\Api\Data\CreditmemoCommentExtensionInterface

$extensionAttributes

Returns

$this

setIsCustomerNotified()

setIsCustomerNotified

(

$isCustomerNotified

)

Sets the is-customer-notified flag value for the credit memo.

Parameters

int

$isCustomerNotified

Returns

$this

Implemented in Comment.

setIsVisibleOnFront()

setIsVisibleOnFront

(

$isVisibleOnFront

)

Sets the is-visible-on-storefront flag value for the credit memo.

Parameters

int

$isVisibleOnFront

Returns

$this

Implemented in Comment.

setParentId()

setParentId

(

$id

)

Sets the parent ID for the credit memo.

Parameters

int

$id

Returns

$this

Implemented in Comment.

Field Documentation

COMMENT

const COMMENT = 'comment'

Definition at line 42 of file CreditmemoCommentInterface.php.

CREATED_AT

const CREATED_AT = 'created_at'

Definition at line 46 of file CreditmemoCommentInterface.php.

ENTITY_ID

const ENTITY_ID = 'entity_id'

#+ Constants for keys of data array. Identical to the name of the getter in snake case.

Definition at line 26 of file CreditmemoCommentInterface.php.

IS_CUSTOMER_NOTIFIED

const IS_CUSTOMER_NOTIFIED = 'is_customer_notified'

Definition at line 34 of file CreditmemoCommentInterface.php.

IS_VISIBLE_ON_FRONT

const IS_VISIBLE_ON_FRONT = 'is_visible_on_front'

Definition at line 38 of file CreditmemoCommentInterface.php.

PARENT_ID

const PARENT_ID = 'parent_id'

Definition at line 30 of file CreditmemoCommentInterface.php.

---

The documentation for this interface was generated from the following file:

• vendor/magento/module-sales/Api/Data/CreditmemoCommentInterface.php