Skip to main content

MGCLatticeProductionReportFinishedRequestContract

Data contract for production report as finished requests containing ProdId, PostingDate, GoodQty, ErrorQty, EndJob (end the job: the order becomes Reported as finished) and AcceptError (end the job even when route jobs have not been reported - the form's "Accept error").

Methods​

new​

Initializes a new instance of the MGCLatticeProductionReportFinishedRequestContract class.

  • Visibility: public
  • Returns: void

No parameters.

construct​

Creates a new instance of the MGCLatticeProductionReportFinishedRequestContract class.

  • Visibility: public
  • Returns: MGCLatticeProductionReportFinishedRequestContract A new MGCLatticeProductionReportFinishedRequestContract 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 user context under which the operation executes.

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

parmProdId​

Gets or sets the production order identifier.

  • Visibility: public
  • Returns: ProdId The ProdId value.
NameTypeOptionalDescription
_prodIdProdIdYesThe ProdId value.

parmPostingDate​

Gets or sets the posting date for the journal entry.

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

parmGoodQty​

Gets or sets the good (accepted) quantity produced or reported.

  • Visibility: public
  • Returns: Qty The GoodQty value.
NameTypeOptionalDescription
_goodQtyQtyYesThe GoodQty value.

parmErrorQty​

Gets or sets the error (rejected) quantity produced or reported.

  • Visibility: public
  • Returns: Qty The ErrorQty value.
NameTypeOptionalDescription
_errorQtyQtyYesThe ErrorQty value.

parmAcceptError​

Gets or sets whether the report as finished accepts errors - the "Accept error" option of the standard form. Applies when EndJob is set: true ends the job even when the order's route jobs or BOM lines have not been reported as finished (the usual integration case: no job-level feedback); false (default) stops with "Job... has not been reported as finished" exactly as the form does without the option.

  • Visibility: public
  • Returns: boolean The AcceptError value.
NameTypeOptionalDescription
_acceptErrorbooleanYesThe AcceptError value.

parmEndJob​

Gets or sets whether this report ends the job - the "End job" option of the standard report as finished. False (default, as Microsoft's programmatic report as finished defaults it) reports a partial quantity: the order keeps its status and its remaining expected receipt. True marks the order Reported as finished and clears the remaining quantity; it requires the BOM and route to be finished unless AcceptError is set.

  • Visibility: public
  • Returns: boolean The EndJob value.
NameTypeOptionalDescription
_endJobbooleanYesThe EndJob 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.

parmProdIdExternalKey​

Gets or sets the external system's key of the production order, in place of ProdId.

  • Visibility: public
  • Returns: MGCLatticeExternalKey The ProdIdExternalKey value.
NameTypeOptionalDescription
_prodIdExternalKeyMGCLatticeExternalKeyYesThe ProdIdExternalKey value.

parmPreviewMode​

Gets or sets whether the request runs as a preview. The operation has no preview: a request with PreviewMode set is refused with PreviewUnsupported before anything runs.

  • Visibility: public
  • Returns: boolean The current preview flag.
NameTypeOptionalDescription
_previewModebooleanYesThe preview flag to set.