Docs

Put Or Post Credit Memo

PUT

Query

Field selectionChoose which fields should be included in the response. Learn more
string

Comma-separated response fields to include.

Body

Arguments
string

Additional data.

number

Credit memo negative adjustment.

number
string

Comment.

object
stringrequired
number

Credit memo positive adjustment.

number

The base cost for a credit memo item.

number
date

Created-at timestamp.

stringrequired
number

Credit memo adjustment.

number

The base discount amount for a credit memo item.

number
number

Credit memo ID.

number

Credit memo base adjustment.

number

The base discount tax compensation amount for a credit memo item.

object

ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoCommentInterface

number
number

Credit memo negative base adjustment.

number

The base price for a credit memo item.

string
number

Is-customer-notified flag value.

number

Credit memo positive base adjustment.

number

Base price including tax.

string
number

Is-visible-on-storefront flag value.

string

Credit memo base currency code.

number

Base row total.

string
number

Parent ID.

number

Credit memo base discount amount.

number

Base row total including tax.

string
number

Credit memo base discount tax compensation amount.

number

Base tax amount.

string
number

Credit memo base grand total.

number

Base WEEE tax applied amount.

string
number

Credit memo base shipping amount.

number

Base WEEE tax applied row amount.

string
number

Credit memo base shipping discount tax compensation amount.

number

Base WEEE tax disposition.

string
number

Credit memo base shipping including tax.

number

Base WEEE tax row disposition

string
number

Credit memo base shipping tax amount.

string

Description.

number

Credit memo base subtotal.

number

Discount amount.

number

Credit memo base subtotal including tax.

number

Discount tax compensation amount.

number

Credit memo base tax amount.

number

Credit memo item ID.

number

Credit memo base-to-global rate.

object

ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoItemInterface

number

Credit memo base-to-order rate.

string

Name.

number

Credit memo billing address ID.

number

Order Item Id

array

Array of any credit memo comments. Otherwise, null.

number

Parent ID.

date

Credit memo created-at timestamp.

number

Price.

number

Credit memo status.

number

Price including tax.

number

Credit memo discount amount.

number

Product ID.

string

Credit memo discount description.

number

Quantity.

number

Credit memo discount tax compensation amount.

number

Row total.

number

Credit memo email sent flag value.

number

Row total including tax.

number

Credit memo ID.

string

SKU

object

ExtensionInterface class for @see \Magento\Sales\Api\Data\CreditmemoInterface

number

Tax amount.

string

Credit memo global currency code.

number

WEEE tax applied

number

Credit memo grand total.

number

WEEE tax applied row amount.

string

Credit memo increment ID.

number

WEEE tax disposition.

number

Credit memo invoice ID.

number

WEEE tax row disposition.

arrayrequired

Array of credit memo items.

string

Credit memo order currency code.

number

Credit memo order ID.

number

Credit memo shipping address ID.

number

Credit memo shipping amount.

number

Credit memo shipping discount tax compensation amount.

number

Credit memo store-to-order rate.

number

Credit memo shipping including tax.

number

Credit memo shipping tax amount.

number

Credit memo state.

string

Credit memo store currency code.

number

Credit memo store ID.

number

Credit memo store-to-base rate.

number

Credit memo subtotal.

number

Credit memo subtotal including tax.

number

Credit memo tax amount.

string

Credit memo transaction ID.

date

Credit memo updated-at timestamp.

Every app you connect,one REST pattern

Call any app with one REST pattern. MindCloud handles each provider's auth, request shape, and responses for you.

Learn what the Universal API is
One REST patternUse the same request structure across apps like Slack, HubSpot, Salesforce, and thousands more.
Managed connectionsSend a MindCloud connection ID instead of handling provider tokens, refresh logic, and credential storage yourself.
Action-level docsEach action page shows the exact endpoint, required arguments, optional controls, and response behavior for that app version.