MGCLatticePaymentJournalService

Custom service for payment journal operations: customer and vendor payment posting (including prepayments marked against an order, and vendor check payments generated before posting), transaction settlement, and reversing a posted customer or vendor payment with the standard reversal that covers it.

Methods

new

Initializes a new instance of the MGCLatticePaymentJournalService class.

• Visibility: public
• Returns: void

No parameters.

construct

Creates a new instance of the MGCLatticePaymentJournalService class.

• Visibility: public
• Returns: MGCLatticePaymentJournalService A new MGCLatticePaymentJournalService instance.

No parameters.

postCustomerPaymentJournal

Posts a customer payment journal with payment lines.

• Visibility: public
• Returns: MGCLatticeOrderOperationResponseContract An MGCLatticeOrderOperationResponseContract indicating success or failure with details.

Name	Type	Optional	Description
_request	MGCLatticePaymentJournalPostRequestContract	No	The request containing JournalNameId, payment lines with AccountNum/amounts, and standard header fields.

postVendorPaymentJournal

Posts a vendor payment journal with payment lines. With GeneratePayments, the lines whose method of payment needs Generate payments before posting (for example the check method: "Check number must be filled in") get their checks first, drawn on the line's bank account with the next numbers of its check layout, in the same transaction as the posting; the message lists the check numbers.

• Visibility: public
• Returns: MGCLatticeOrderOperationResponseContract An MGCLatticeOrderOperationResponseContract indicating success or failure with details; DocumentId and PostedDocumentId are the journal.

Name	Type	Optional	Description
_request	MGCLatticePaymentJournalPostRequestContract	No	The request containing JournalNameId, payment lines with AccountNum/amounts, GeneratePayments, and standard header fields.

settleCustomerTransactions

Settles customer payment and invoice transactions using the SpecTrans settlement framework.

• Visibility: public
• Returns: MGCLatticeOrderOperationResponseContract An MGCLatticeOrderOperationResponseContract indicating success or failure with details.

Name	Type	Optional	Description
_request	MGCLatticeSettlementRequestContract	No	The request containing AccountNum, PaymentTransRecId, settlement lines, and standard header fields.

settleVendorTransactions

Settles vendor payment and invoice transactions using the SpecTrans settlement framework.

• Visibility: public
• Returns: MGCLatticeOrderOperationResponseContract An MGCLatticeOrderOperationResponseContract indicating success or failure with details.

Name	Type	Optional	Description
_request	MGCLatticeSettlementRequestContract	No	The request containing AccountNum, PaymentTransRecId, settlement lines, and standard header fields.

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.

• Visibility: public
• 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.

Name	Type	Optional	Description
_request	MGCLatticePaymentReversalRequestContract	No	The request containing AccountNum (or AccountNumExternalKey), Voucher, ReversalDate, ReasonCode, ReasonComment, ReversalJournalNameId, PostReversalJournal and the standard header fields.

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.

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

Name	Type	Optional	Description
_request	MGCLatticePaymentReversalRequestContract	No	The request containing AccountNum (or AccountNumExternalKey), Voucher, ReversalDate, ReasonCode, ReasonComment, ReversalJournalNameId, PostReversalJournal and the standard header fields.

reverseCustomerPaymentBatch

Reverses several customer payments in a single bulk operation; each item runs as a single reverseCustomerPayment and gets its own result.

• Visibility: public
• Returns: MGCLatticeBulkOperationResponseContract An MGCLatticeBulkOperationResponseContract containing per-item results.

Name	Type	Optional	Description
_requests	List	No	List of MGCLatticePaymentReversalRequestContract.

reverseVendorPaymentBatch

Reverses several vendor payments in a single bulk operation; each item runs as a single reverseVendorPayment and gets its own result.

• Visibility: public
• Returns: MGCLatticeBulkOperationResponseContract An MGCLatticeBulkOperationResponseContract containing per-item results.

Name	Type	Optional	Description
_requests	List	No	List of MGCLatticePaymentReversalRequestContract.

postCustomerPaymentJournalBatch

Posts multiple customer payment journals in a single bulk operation.

• Visibility: public
• Returns: MGCLatticeBulkOperationResponseContract An MGCLatticeBulkOperationResponseContract containing per-item results.

Name	Type	Optional	Description
_requests	List	No	List of MGCLatticePaymentJournalPostRequestContract.

postVendorPaymentJournalBatch

Posts multiple vendor payment journals in a single bulk operation.

• Visibility: public
• Returns: MGCLatticeBulkOperationResponseContract An MGCLatticeBulkOperationResponseContract containing per-item results.

Name	Type	Optional	Description
_requests	List	No	List of MGCLatticePaymentJournalPostRequestContract.

settleCustomerTransactionsBatch

Settles multiple customer transaction sets in a single bulk operation.

• Visibility: public
• Returns: MGCLatticeBulkOperationResponseContract An MGCLatticeBulkOperationResponseContract containing per-item results.

Name	Type	Optional	Description
_requests	List	No	List of MGCLatticeSettlementRequestContract.

settleVendorTransactionsBatch

Settles multiple vendor transaction sets in a single bulk operation.

• Visibility: public
• Returns: MGCLatticeBulkOperationResponseContract An MGCLatticeBulkOperationResponseContract containing per-item results.

Name	Type	Optional	Description
_requests	List	No	List of MGCLatticeSettlementRequestContract.