MGCLatticeSettlementRequestContract

Data contract for transaction settlement requests containing AccountNum, PaymentTransRecId, and settlement lines.

Methods

new

Initializes a new instance of the MGCLatticeSettlementRequestContract class.

• Visibility: public
• Returns: void

No parameters.

construct

Creates a new instance of the MGCLatticeSettlementRequestContract class.

• Visibility: public
• Returns: MGCLatticeSettlementRequestContract A new MGCLatticeSettlementRequestContract 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 or vendor account number.

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

Name	Type	Optional	Description
_accountNum	str	Yes	The AccountNum value.

parmPaymentTransRecId

Gets or sets the record identifier of the payment transaction for settlement.

• Visibility: public
• Returns: int64 The PaymentTransRecId value.

Name	Type	Optional	Description
_paymentTransRecId	int64	Yes	The PaymentTransRecId value.

parmPaymentInvoiceId

Gets or sets the invoice number the payment carries, used to resolve the payment transaction when neither PaymentTransRecId nor PaymentVoucher is supplied. It is matched against the invoice number of the payment transaction (CustTrans / VendTrans of type Payment) of AccountNum; a customer payment posted by postCustomerPaymentJournal carries the line's InvoiceId. A vendor payment carries no invoice number: identify it by PaymentVoucher.

• Visibility: public
• Returns: str The PaymentInvoiceId value.

Name	Type	Optional	Description
_paymentInvoiceId	str	Yes	The PaymentInvoiceId value.

parmPaymentVoucher

Gets or sets the voucher of the posted payment, used to resolve the payment transaction when PaymentTransRecId is not supplied. It is matched against the voucher of the payment transaction (CustTrans / VendTrans of type Payment) of AccountNum.

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

Name	Type	Optional	Description
_paymentVoucher	Voucher	Yes	The PaymentVoucher 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 request's external key members hold.

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

Name	Type	Optional	Description
_externalSystem	MGCLatticeExternalSystemId	Yes	The ExternalSystem value.

parmAccountNumExternalKey

Gets or sets the external system's key of the customer (customer settlements) or vendor (vendor settlements), in place of AccountNum.

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

Name	Type	Optional	Description
_accountNumExternalKey	MGCLatticeExternalKey	Yes	The AccountNumExternalKey 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.