Skip to main content

MGCLatticePaymentJournalService.reverseVendorPayment

Reverses a posted vendor payment voucher of a vendor account with the standard reversal that covers it: a payment made by check is reversed by the check reversal (the Checks page's Payment reversal; its settlements are reversed), a payment not posted to a bank account by the transaction reversal (TransactionReversal_Vend), which refuses a settled payment. A vendor payment posted to a bank account other than by check has no standard reversal and is refused. 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 the check is pending cancellation; with PostReversalJournal the journal is posted in the same transaction and the check is canceled.

  • HTTP method: POST
  • Route: /api/services/MGCLatticeGeneralLedgerServiceGroup/MGCLatticePaymentJournalService/reverseVendorPayment
  • 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 reversal, or the check reversal journal left for review.

Security​

  • Requires privilege MGCLatticePaymentReverseMaintain