MGCLatticeVendorPaymentGenerationRequestContract

Data contract for generating the payments of an open vendor payment journal (Generate payments): the journal, the optional method of payment and bank account that narrow the generation, whether to post the journal afterwards, and the standard header fields.

Methods

new

Initializes a new instance of the MGCLatticeVendorPaymentGenerationRequestContract class.

• Visibility: public
• Returns: void

No parameters.

construct

Creates a new instance of the MGCLatticeVendorPaymentGenerationRequestContract class.

• Visibility: public
• Returns: MGCLatticeVendorPaymentGenerationRequestContract A new MGCLatticeVendorPaymentGenerationRequestContract 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 open vendor payment journal whose payments to generate, for example the journal generatePaymentProposal created. Required unless JournalNumExternalKey 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.

parmMethodOfPayment

Gets or sets the method of payment to generate, as the Generate payments dialog asks for one. Optional: without it the lines whose method of payment needs generation before posting (payment type Check, a check number demanded by the method's payment control, or payment status Sent demanded) are generated, one standard run per method; lines that post without generation are left as they are.

• Visibility: public
• Returns: PaymMode The MethodOfPayment value.

Name	Type	Optional	Description
_methodOfPayment	PaymMode	Yes	The MethodOfPayment value.

parmBankAccountId

Gets or sets the bank account the checks are drawn on, as the Generate payments dialog asks for one. Optional: without it each line's checks are drawn on the bank account the line pays from (its offset bank account). With it, only the lines that pay from this bank account are generated.

• Visibility: public
• Returns: CompanyBankAccountId The BankAccountId value.

Name	Type	Optional	Description
_bankAccountId	CompanyBankAccountId	Yes	The BankAccountId value.

parmPostAfterGenerate

Gets or sets whether the journal is posted once its payments are generated, in the same transaction: when the posting fails, the generation is undone too. Optional; defaults to false (the journal stays open with its payments generated).

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

Name	Type	Optional	Description
_postAfterGenerate	boolean	Yes	The PostAfterGenerate 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 generated.

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

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