Issue Credit Memo Action

Issue credit memos for disputed invoices to resolve billing disputes.

Specify the credit request list to automate the creation of credit memos during the dispute resolution process. The credit request list includes the invoice ID, the total credit amount, an optional description, and a detailed list of specific invoice lines with their corresponding credit amounts.

This action is available in API version 66.0 and later.

Special Access Rules

The Issue Credit Memo Action is available in Enterprise, Developer, and Unlimited Editions where Dispute Management is enabled in Billing.

Supported REST HTTP Methods

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

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is a placeholder for your OAuth access token.

Inputs

Input	Type	Description
`creditRequestList`	Apex-defined	List of Apex-defined creditRequestInputRepresentations objects that contains the invoice ID, credit amount, description, and a list of creditLineRequestInputRepresentations objects. The creditLineRequestInputRepresentations objects include the invoice line ID, credit line amount, and a description. See CreditLineRequestInputRepresentations Apex class.

Outputs

Output	Type	Description
`creditResponse`	Apex-defined	An Apex-defined creditResponseOutputRepresentations object that contains the status and any additional information.

Example

POST

This sample request is for the Issue Credit Memo action.

1{
2  "inputs": [
3    {
4      "creditRequestList": [
5        {
6          "invoiceId": "801xx000003GYexAAG",
7          "creditAmount": 100,
8          "description": "Credit for disputed charges",
9          "creditLineRequestInputRepresentations": [
10            {
11              "invoiceLineId": "801xx000003GYeyAAG",
12              "creditLineAmount": 50,
13              "description": "Line-level credit"
14            }
15          ]
16        }
17      ]
18    }
19  ]
20}

This sample response is for the Issue Credit Memo action.

1[
2  {
3    "actionName": "blngDsptIssueCreditMemo",
4    "errors": null,
5    "invocationId": null,
6    "isSuccess": true,
7    "outcome": null,
8    "outputValues": {
9      "creditResponse": {
10        "success": true,
11        "message": "Credit memo issued successfully"
12      }
13    },
14    "sortOrder": -1,
15    "version": 1
16  }
17]