MGCLatticePaymentReversalRequestContract

Data contract for reversing a posted customer or vendor payment: the account, the payment voucher, the reversal date, the optional financial reason, the check reversal journal options, and the standard header fields.

Methods

new

Initializes a new instance of the MGCLatticePaymentReversalRequestContract class.

• Visibility: public
• Returns: void

No parameters.

construct

Creates a new instance of the MGCLatticePaymentReversalRequestContract class.

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

No parameters.

parmCorrelationId

Gets or sets the correlation identifier for tracing the request across systems.

• Visibility: public
• Returns: Guid The CorrelationId value.

Name	Type	Optional	Description
_correlationId	Guid	Yes	The CorrelationId value.

parmRequestId

Gets or sets the unique request identifier for idempotency.

• Visibility: public
• Returns: Guid The RequestId value.

Name	Type	Optional	Description
_requestId	Guid	Yes	The RequestId value.

parmLegalEntityId

Gets or sets the legal entity (company) in which to execute the operation.

• Visibility: public
• Returns: DataAreaId The LegalEntityId value.

Name	Type	Optional	Description
_legalEntityId	DataAreaId	Yes	The LegalEntityId value.

parmUserContext

Gets or sets the user context under which the operation executes.

• Visibility: public
• Returns: UserId The UserContext value.

Name	Type	Optional	Description
_userContext	UserId	Yes	The UserContext value.

parmAccountNum

Gets or sets the customer account (reverseCustomerPayment) or vendor account (reverseVendorPayment) the payment was posted to. Required unless AccountNumExternalKey names it.

• Visibility: public
• Returns: CustVendAC The AccountNum value.

Name	Type	Optional	Description
_accountNum	CustVendAC	Yes	The AccountNum value.

parmAccountNumExternalKey

Gets or sets the external system's key of the customer or vendor, in place of AccountNum. Uses ExternalSystem.

• Visibility: public
• Returns: MGCLatticeExternalKey The AccountNumExternalKey value.

Name	Type	Optional	Description
_accountNumExternalKey	MGCLatticeExternalKey	Yes	The AccountNumExternalKey value.

parmExternalSystem

Gets or sets the external system whose key AccountNumExternalKey holds.

• Visibility: public
• Returns: MGCLatticeExternalSystemId The ExternalSystem value.

Name	Type	Optional	Description
_externalSystem	MGCLatticeExternalSystemId	Yes	The ExternalSystem value.

parmVoucher

Gets or sets the voucher of the posted payment to reverse. Required.

• Visibility: public
• Returns: Voucher The Voucher value.

Name	Type	Optional	Description
_voucher	Voucher	Yes	The Voucher value.

parmReversalDate

Gets or sets the date the reversal posts on. Optional; defaults to today. It cannot be before the payment date.

• Visibility: public
• Returns: TransDate The ReversalDate value.

Name	Type	Optional	Description
_reversalDate	TransDate	Yes	The ReversalDate value.

parmReasonCode

Gets or sets the financial reason code recorded on the reversal. Optional unless the parameters demand a reason (accounts receivable transaction reversal or payment cancellation, check reversal); it must exist in the financial reasons of the legal entity.

• Visibility: public
• Returns: ReasonCode The ReasonCode value.

Name	Type	Optional	Description
_reasonCode	ReasonCode	Yes	The ReasonCode value.

parmReasonComment

Gets or sets the reason comment recorded on the reversal. Optional.

• Visibility: public
• Returns: ReasonComment The ReasonComment value.

Name	Type	Optional	Description
_reasonComment	ReasonComment	Yes	The ReasonComment value.

parmReversalJournalNameId

Gets or sets the check reversal journal name, for a payment made by check when the cash and bank parameters require check reversals to be reviewed in a check reversal journal. Optional: without it the legal entity's only check reversal journal name is used. Ignored for any other reversal.

• Visibility: public
• Returns: LedgerJournalNameId The ReversalJournalNameId value.

Name	Type	Optional	Description
_reversalJournalNameId	LedgerJournalNameId	Yes	The ReversalJournalNameId value.

parmPostReversalJournal

Gets or sets whether the check reversal journal is posted in the same request, which reverses the payment and cancels the check. Optional; defaults to false: the journal is left for review and the check is pending cancellation until it is posted. Only used when a check reversal journal is required.

• Visibility: public
• Returns: boolean The PostReversalJournal value.

Name	Type	Optional	Description
_postReversalJournal	boolean	Yes	The PostReversalJournal value.

parmPreviewMode

Gets or sets whether the request runs in preview mode. The operation has no preview: a request with PreviewMode set to true is refused with PreviewUnsupported before anything is reversed.

• Visibility: public
• Returns: boolean The current preview flag.

Name	Type	Optional	Description
_previewMode	boolean	Yes	The preview flag to set.