Skip to main content

MGCLatticePaymentJournalService.reverseCustomerPayment

Reverses a posted customer payment voucher of a customer account with the standard reversal that covers it: a payment posted to a bank account is canceled as the bank's payment cancellation does (BankPaymCancel: the settlements of the payment are reversed, so the invoices it paid are open again); a payment made by check is reversed by the check reversal; any other payment by the transaction reversal (TransactionReversal_Cust), which refuses a settled payment. When the cash and bank parameters require check reversals to be reviewed, the check reversal creates a check reversal journal (ReversalJournalNameId, or the only check reversal journal name) and posts it only with PostReversalJournal.

  • HTTP method: POST
  • Route: /api/services/MGCLatticeGeneralLedgerServiceGroup/MGCLatticePaymentJournalService/reverseCustomerPayment
  • Service class: MGCLatticePaymentJournalService

Parameters​

NameTypeOptionalDescription
_requestMGCLatticePaymentReversalRequestContractNoThe request containing AccountNum (or AccountNumExternalKey), Voucher, ReversalDate, ReasonCode, ReasonComment, ReversalJournalNameId, PostReversalJournal and the standard header fields.

Returns​

MGCLatticeOrderOperationResponseContract

An MGCLatticeOrderOperationResponseContract: DocumentId is the reversed payment voucher, PostedDocumentId the voucher of the cancellation or reversal, or the check reversal journal left for review.

Security​

  • Requires privilege MGCLatticePaymentReverseMaintain