Publishing settlement and refund details

The payment transactions mapping between orders without invoices and events is available for returns, exchanges, goodwill, and cancellation.

When a refund or settlement payment transaction is present without an invoice in events such as cancellation, addition of lines, or change in taxes or shipping charges, the mapping between that order event and payment transaction is available.

An association between order event and payment transaction at source along with financial posting is provided to facilitate the financial integrations in Sterling™ Order Management System with the following steps:

  • Comprehensive payment audit information is logged in payment audit database tables.
  • The On Refund or Settlement Payment Transaction event under the payment collection transaction publishes the mapping between the order event and the payment transaction. The payment transactions trigger this event and the payment is distributed after settlement in the Sterling Order Management System.
To map payment transactions, you must enable the following properties in the customer_overrides.properties file:
  • yfs.yfs.payment.reason.enablePaymentAudit
  • yfs.yfs.payment.reason.persistOrderDataDuringCreateOrder
  • yfs.yfs.payment.reason.clubChargesForSameReasonWithDifferetPaymentTypes
The following table describes the reason code and text for settlement transactions:
Reason code Reason text
SHIPMENT Shipment Invoice
ORDER_INVOICE Order Invoice
ADJUSTMENT Adjustment Invoice
CHANGE_PRICE Change Price
ADDITION Add Order Line
CREATE_ORDER Create Order Settlement
INSUFFICIENT_CHARGE Insufficient Charge
The following table describes the reason code and text for refund transactions:
Reason code Reason text
RETURN Return Invoice
ADJUSTMENT Adjustment Invoice
CHANGE_PRICE Change Price
CANCEL Cancel Quantity
EXCESS_CHARGE Excess Charge