Credit Memo Apply List (POST)

Specify the credit memo ID and the amounts to be applied, with the total of all applied amounts not exceeding the credit memo's balance.

The credit amount for each invoice can’t surpass the original charge or adjustment amount, and the overall credit amount must not exceed the invoice's outstanding balance. The exceptions include any taxes calculated by an external service.

For example, your organization sold 10 tablets at US$500 each, totaling $5000, to a vendor who later reported that 6 tablets were defective. Your accounts receivable team creates a $3000 credit memo by using the standalone Credit Memo API. Additionally, the team applies this credit to the original invoice by using the Credit Memo Apply API.

Special Access Rules

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

Resource

/commerce/invoicing/credit-memos/creditMemoId/actions/apply

Resource example

https://yourInstance.salesforce.com/services/data/v63.0/commerce/invoicing/credit-memos/50gSG0000000XATYA2/actions/apply

Available version

62.0

HTTP methods

POST

Path parameter for POST

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

Request body for POST

JSON example

{
  "applications": [
    {
      "appliedToId": "3ttxx000000003FAAQ",
      "amount": 10,
      "description": "Apply to invoice for refund",
      "effectiveDate": "2024-07-01"
    },
    {
      "appliedToId": "3ttxx0000000001AAA",
      "amount": 100
    }
  ]
}

Properties

Name	Type	Description	Required or Optional	Available Version
applications	Credit Memo Apply Application Input[]	List of one or more applications to apply the credit memo for. Each application represents an invoice that’s credited by using the balance of the specified credit memo.	Required	62.0

Response body for POST

Credit Memo Apply List