MGCLatticeJournalReversalRequestContract

Data contract for reversing a posted ledger journal: the journal (or one voucher of it), the reversal date, the optional financial reason, and the standard header fields.

Methods

new

Initializes a new instance of the MGCLatticeJournalReversalRequestContract class.

• Visibility: public
• Returns: void

No parameters.

construct

Creates a new instance of the MGCLatticeJournalReversalRequestContract class.

• Visibility: public
• Returns: MGCLatticeJournalReversalRequestContract A new MGCLatticeJournalReversalRequestContract 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.

parmJournalNum

Gets or sets the posted ledger journal to reverse. Required unless JournalNumExternalKey or Voucher names it.

• Visibility: public
• Returns: LedgerJournalId The JournalNum value.

Name	Type	Optional	Description
_journalNum	LedgerJournalId	Yes	The JournalNum value.

parmJournalNumExternalKey

Gets or sets the external system's key of the journal, in place of JournalNum. Uses ExternalSystem.

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

Name	Type	Optional	Description
_journalNumExternalKey	MGCLatticeExternalKey	Yes	The JournalNumExternalKey value.

parmExternalSystem

Gets or sets the external system whose key JournalNumExternalKey holds.

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

Name	Type	Optional	Description
_externalSystem	MGCLatticeExternalSystemId	Yes	The ExternalSystem value.

parmVoucher

Gets or sets one voucher of the journal to reverse. Optional: without it every voucher of the journal is reversed. Without a journal it names the posted journal that contains it.

• 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 date of a voucher it reverses.

• 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 of the module demand a reason; 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.

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.