Unapply Credit Action

Unapply a credit memo or credit memo line from an invoice or invoice line, respectively.

This action unapplies the credit from an invoice or invoice line. This process involves crediting the applied amount of the credit memo invoice application or credit memo line invoice line record to the related credit memo or credit memo line and invoice or invoice line.

This action is available in API version 62.0 and later.

Special Access Rules

The Apply Credit action is available in Enterprise, Developer, and Unlimited Editions where Billing is enabled. To use this action, you need the Credit Memo Operations User permission set.

Supported REST HTTP Methods

URI: /services/data/v68.0/actions/standard/unapplyCredit

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is a placeholder for your OAuth access token.

Inputs

Input	Type	Description
`effectiveDate`	string	Date when the credit is unapplied from an invoice or invoice line.
`description`	string	Additional details about the credit memo invoice application or credit memo line invoice line record of type `Applied` that’s processed.
`recordId`	string	Required. ID of the credit memo invoice application or credit memo line invoice line record of type `Applied` that’s processed to unapply the credit.

Outputs

Output	Type	Description
`recordId`	string	ID of the credit memo invoice application or credit memo line invoice line record of type `Unapplied` that the action created.

Example

POST

This example shows a sample request for the Unapply Credit action.

1{
2  "inputs": [
3    {
4      "recordId": "4sFDU000000005g2AA",
5      "description": "Unapplied credit memo from an invoice",
6      "effectiveDate": "2024-08-27"
7    }
8  ]
9}

This example shows a sample response for the Unapply Credit action.

1{
2    "actionName": "unapplyCredit",
3    "errors": null,
4    "invocationId": null,
5    "isSuccess": true,
6    "outputValues": {
7      "recordId": "4sFDU00000000602AA"
8    },
9    "sortOrder": -1,
10    "version": 1
11  }