MGCLatticePaymentJournalPostRequestContract

Data contract for payment journal posting requests containing JournalNameId, Description, PostingDate, payment lines and, for vendor payments, GeneratePayments.

Methods

new

Initializes a new instance of the MGCLatticePaymentJournalPostRequestContract class.

• Visibility: public
• Returns: void

No parameters.

construct

Creates a new instance of the MGCLatticePaymentJournalPostRequestContract class.

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

parmJournalNameId

Gets or sets the journal name identifier that determines the journal type and default settings.

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

Name	Type	Optional	Description
_journalNameId	LedgerJournalNameId	Yes	The JournalNameId value.

parmDescription

Gets or sets the descriptive text for the journal or transaction.

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

Name	Type	Optional	Description
_description	Description	Yes	The Description value.

parmPostingDate

Gets or sets the posting date for the journal entry.

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

Name	Type	Optional	Description
_postingDate	TransDate	Yes	The PostingDate value.

parmLines

Gets or sets the collection of line-level details for the operation.

• Visibility: public
• Returns: List The collection of line items.

Name	Type	Optional	Description
_lines	List	Yes	The collection of line items.

parmExternalSystem

Gets or sets the external system whose keys the lines' external key members hold.

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

Name	Type	Optional	Description
_externalSystem	MGCLatticeExternalSystemId	Yes	The ExternalSystem value.

parmGeneratePayments

Gets or sets whether the payments of the vendor payment lines whose method of payment needs Generate payments before posting (payment type Check, a check number demanded by the method's payment control, or payment status Sent demanded) are generated before the journal is posted, in the same transaction as the posting: the checks are drawn on each line's bank account (BankAccountId, required on those lines) with the next numbers of its check layout. Vendor payment journals only; optional, defaults to false (such lines then fail at posting).

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

Name	Type	Optional	Description
_generatePayments	boolean	Yes	The GeneratePayments value.

parmPreviewMode

Gets or sets whether the request runs in preview mode. This operation does not implement a preview: a request with PreviewMode set to true is refused with PreviewUnsupported before anything is created or posted.

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

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