CreateCreditMemoFromAppeasement

Rule

Changed on:

2 Jan 2024

Overview

The rule creates a CreditMemo for the BillingAccount using the supplied Order details.

Plugin Name	Order Reference Module
Namespace	[[account.id]].order

The Order Reference Module is the foundation for order-related implementations. It provides reference workflows for click & collect, home delivery and mixed baskets and those needed to build your own. Extensible by design, use this Module as a base to build a solution to your customers' needs.

Order Reference Module

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

All generated exceptions will be wrapped with RubixException: 422.

Configuration example

1{
2  "name": "<ACCOUNTID>.order.CreateCreditMemoFromAppeasement",
3  "props": {
4    "creditMemoType": "CREDIT_MEMO",
5    "creditMemoItemType": "CREDIT_MEMO_ITEM"
6  }
7}

Language: json

Version History

2023-08-04

v1.0.0

refers to plugin

Copyright © 2024 Fluent Retail Pty Ltd (trading as Fluent Commerce). All rights reserved. No materials on this docs.fluentcommerce.com site may be used in any way and/or for any purpose without prior written authorisation from Fluent Commerce. Current customers and partners shall use these materials strictly in accordance with the terms and conditions of their written agreements with Fluent Commerce or its affiliates.