Unapply Credit Memo (POST)

Unapply a credit memo from an invoice and return the invoice and the credit memo to their pre-application states.

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 

1/commerce/invoicing/credit-memo-inv-applications/{creditMemoInvApplicationId}/actions/unapply

Resource Example 

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

Available Version 

62.0

HTTP Methods 

POST

Path Parameter for POST 

NameTypeDescriptionRequired or OptionalAvailable Version
creditMemo​InvApplication​IdStringID of the credit memo invoice application.Required62.0

Request Body for POST 

JSON Example

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

Properties

NameTypeDescriptionRequired or OptionalAvailable Version
descriptionStringExplanation or reason for unapplying the credit memo.Optional62.0
effectiveDateStringEffective date for the credit memo.Optional62.0

Response Body for POST 

Credit Memo Unapply