Credit memo service

 

This service handles all functionality related to credit memos (vouchers/store credit). Creating them, validating and authorizing and getting information when paying with a credit memo.

Configurations

To be able to use a credit memo as payment each store has to have a credit memo payment type configured.

The centralized functionality for the credit memos in the site service profile also needs to be activated.

Main functionality

 

Name Description
AuthorizeCreditMemoPayment Checks if a credit memo can be used for payment and gets information about the credit memo for the payment
Conclude transaction

When the POS finishes a sale (after payment) various updates are done through the Site service including updating the credit memo information if a payment was done with a credit memo or if one was issued due to returns.

See function UpdateCreditMemoStatusin the Transaction service to see what information is being updated.

GetCreditmemoBalance Returns the balance of a given credit voucher. This function checks with the HO through the Site service and retrieves the balance amount.
HandleCreditVoucherValidationEnum Handles results other than ValidationSuccess and displays the appropriate message if that applies
Issue credit memo Creates a credit memo using the site service in the head office location
UpdateCreditMemo Marks the credit voucher as used so that it cannot be used again
VoidCreditMemoPayment Voids a credit memo payment
ValidateCreditMemo Checks if a given credit voucher is valid, and returns the correct balance if needed
PayCreditMemoDialog The payment dialog is in the Credit memo service itself.

POS Operations

Several operations in the POS directly call the Credit memo service. Here below is a list of all the operations and which functions they call

Name Description
Credit memo balance Calls function GetCreditMemoBalance
Pay credit memo Calls function AuthorizeCreditMemoPayment
Void payment Calls function VoidCreditMemoPayment if a credit memo tender line is selected

Development pack

To find this service in the development pack go to DevPack\Source\POS\Services

See also

Site service profile

Transaction service