Skip to main content

MGCLatticeStatusQueryRequestContract

Data contract for status query request operations providing document identifier lookup parameters.

Methods​

new​

Initializes a new instance of the MGCLatticeStatusQueryRequestContract class.

  • Visibility: public
  • Returns: void

No parameters.

construct​

Creates a new instance of the MGCLatticeStatusQueryRequestContract class.

  • Visibility: public
  • Returns: MGCLatticeStatusQueryRequestContract A new MGCLatticeStatusQueryRequestContract instance.

No parameters.

parmCorrelationId​

Gets or sets the correlation identifier for tracing the request across systems.

  • Visibility: public
  • Returns: Guid The CorrelationId value.
NameTypeOptionalDescription
_correlationIdGuidYesThe CorrelationId value.

parmRequestId​

Gets or sets the unique request identifier for idempotency.

  • Visibility: public
  • Returns: Guid The RequestId value.
NameTypeOptionalDescription
_requestIdGuidYesThe RequestId value.

parmLegalEntityId​

Gets or sets the legal entity (company) in which to execute the operation.

  • Visibility: public
  • Returns: DataAreaId The LegalEntityId value.
NameTypeOptionalDescription
_legalEntityIdDataAreaIdYesThe LegalEntityId value.

parmUserContext​

Gets or sets the caller's informational user context (optional); recorded, never used for authorization.

  • Visibility: public
  • Returns: UserId The UserContext value.
NameTypeOptionalDescription
_userContextUserIdYesThe UserContext value.

parmDocumentId​

Gets or sets the document identifier to query (SalesId, PurchId, JournalNum, ProdId, etc.).

  • Visibility: public
  • Returns: str The DocumentId value.
NameTypeOptionalDescription
_documentIdstrYesThe DocumentId value.

parmExternalSystem​

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

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

parmDocumentIdExternalKey​

Gets or sets the external system's key of the document to query, in place of DocumentId. Supported by the sales order, purchase order, production order and journal status queries.

  • Visibility: public
  • Returns: MGCLatticeExternalKey The DocumentIdExternalKey value.
NameTypeOptionalDescription
_documentIdExternalKeyMGCLatticeExternalKeyYesThe DocumentIdExternalKey value.