CreateCreditMemoFromAppeasement
Rule
Changed on:
8 Aug 2025
Overview
The rule creates a CreditMemo for the BillingAccount using the supplied Order details.| Plugin Name | Order Reference Module |
|---|---|
| Namespace | [[account.id]].order |
UI Description
Creates a CreditMemo for the BillingAccount using the supplied Order details.
Accepts
- ORDER
- BILLING ACCOUNT
Actions
- This rule produces a mutation that creates a credit memo
Rule parameters
| Parameter | Description |
| creditMemoType | Type of credit memo. Default value = CREDIT_MEMO |
| creditMemoItemType | Type of credit memo item. Default value = CREDIT_MEMO_ITEM |
Event attributes
| Parameter | Description | Data Type | Required? |
| entityReference | The order reference | EntityReference object | Required |
| appeasementInfo | The appeasement info for calculate tax data | AppeasementAttributes object | Required |
Exceptions
This rule will throw an IllegalArgumentException
- if the
`entityRef/retailerId/entityReference/appeasementInfo`property is not provided - if order not found
- if
`orderItem`not found or`orderItem`without currency - if return settings
`DEFAULT_TAX_TYPE`not found or invalid - if
`defaultTariff`invalid
Configuration example
1{
2 "name": "<ACCOUNTID>.order.CreateCreditMemoFromAppeasement",
3 "props": {
4 "creditMemoType": "CREDIT_MEMO",
5 "creditMemoItemType": "CREDIT_MEMO_ITEM"
6 }
7}