Credit Memo Unapply (POST)

Use this resource if an error occurred when a credit is issued. For example, if an incorrect credit memo is applied to an invoice, or if a credit memo is created for an incorrect amount, use this resource to unapply the credit memo.

Special Access Rules

You need the Credit Memo Operations User permission set to use this API.

Resource

/commerce/invoicing/credit-memo-inv-applications/creditMemoInvApplicationId/actions/unapply

Resource example

https://yourInstance.salesforce.com/services/data/v63.0/commerce/invoicing/credit-memo-inv-applications/4sFSG000002nxPB2AY/actions/unapply

Available version

62.0

HTTP methods

POST

Path parameter for POST

Name	Type	Description	Required or Optional	Available Version
creditMemo​InvApplication​Id	String	ID of the credit memo invoice application.	Required	62.0

Request body for POST

JSON example

{
      "description": "Unapply credit memo from invoice to revert an error",
      "effectiveDate": "2024-07-01"
    }

Properties

Name	Type	Description	Required or Optional	Available Version
description	String	Explanation or reason for unapplying the credit memo.	Optional	62.0
effectiveDate	String	Effective date for the credit memo.	Optional	62.0

Response body for POST

Credit Memo Unapply