MGCLatticeFreeTextInvoiceCancelRequestContract

Data contract for free text invoice cancellation requests containing InvoiceRecId, CancelDate, and reason details.

Methods

new

Initializes a new instance of the MGCLatticeFreeTextInvoiceCancelRequestContract class.

• Visibility: public
• Returns: void

No parameters.

construct

Creates a new instance of the MGCLatticeFreeTextInvoiceCancelRequestContract class.

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

parmInvoiceRecId

Gets or sets the record identifier of the posted invoice to cancel.

• Visibility: public
• Returns: RecId The InvoiceRecId value.

Name	Type	Optional	Description
_invoiceRecId	RecId	Yes	The InvoiceRecId value.

parmInvoiceId

Gets or sets the optional free text invoice number used to resolve the invoice record when InvoiceRecId is not supplied. The natural key is resolved against the posted customer invoice journal (CustInvoiceJour) for a free text invoice.

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

Name	Type	Optional	Description
_invoiceId	str	Yes	The InvoiceId value.

parmCancelDate

Gets or sets the cancellation effective date.

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

Name	Type	Optional	Description
_cancelDate	TransDate	Yes	The CancelDate value.

parmReasonCode

Gets or sets the reason code for the cancellation.

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

Name	Type	Optional	Description
_reasonCode	str	Yes	The ReasonCode value.

parmReasonComment

Gets or sets the additional comment explaining the cancellation reason.

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

Name	Type	Optional	Description
_reasonComment	str	Yes	The ReasonComment value.

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.

parmInvoiceRecIdExternalKey

Gets or sets the external system's key of the free text invoice to cancel, in place of InvoiceRecId or InvoiceId.

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

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