VerifyBillingAccount
Changed on:
30 Nov 2023
Overview
The rule verifies billing account existence, sends event to the billing account workflow, or creates billing account if none found, before the return is initiated.
| 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.
UI Description
Verifies that a billing account exists. If a billing account exists that is associated with a customer, the rule will send an event to the billing account workflow to initiate the return. If no billing account exists, one will be created before the return is initiated.
Accepts
- ORDER
- RETURN ORDER
Actions
- This rule either produces an event that triggers createBillingAccount mutation if the customer has no billing account, OR produces an event and forwards it into the next rule to process the credit.
Rule parameters
Parameter | Description |
BillingAccountExistsEventName | The state to apply to the entity. |
NoBillingAccountExistsEventName | The state to apply to the entity. |
Event attributes
This rule does not directly identify any event attributes.
Exceptions
This rule will throw an IllegalArgumentException
- if the property is not provided
`accountId/retailerId/entityId/entityRef` - if more than one billing account is found
- if attempted against unsupported entities
All generated exceptions will be wrapped with RubixException: 422.
Configuration example
1{
2 "name": "<ACCOUNTID>.order.VerifyBillingAccount",
3 "props": {
4 "BillingAccountExistsEventName": "The state to apply to the entity",
5 "NoBillingAccountExistsEventName": "The state to apply to the entity"
6 }
7}Language: json
Version History
v1.0.0
refers to plugin
