Skip to main content

MGCLatticeInventBOMJournalPostRequestContract

Data contract for posting a BOM journal (postBOMJournal): each line reports a BOM item as finished and consumes its components outside production, as the BOM journal's Report as finished does.

Methods​

construct​

Creates a new instance of the MGCLatticeInventBOMJournalPostRequestContract class.

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

parmJournalNameId​

Gets or sets the BOM journal name. Optional: when empty, the BOM journal name of the inventory parameters is used.

  • Visibility: public
  • Returns: InventJournalNameId The JournalNameId value.
NameTypeOptionalDescription
_journalNameIdInventJournalNameIdYesThe JournalNameId value.

parmDescription​

Gets or sets the journal description. Optional: when empty, the journal name's description is used.

  • Visibility: public
  • Returns: Description The Description value.
NameTypeOptionalDescription
_descriptionDescriptionYesThe Description value.

parmPostingDate​

Gets or sets the date the items are reported as finished; it also selects the BOM version. Optional: today.

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

parmLines​

Gets or sets the BOM items to report as finished. Never null: an empty list until lines are added.

  • Visibility: public
  • Returns: List The lines.
NameTypeOptionalDescription
_linesListYesThe MGCLatticeInventBOMJournalLineContract lines.

parmExternalSystem​

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

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

parmPreviewMode​

Gets or sets whether the request runs as a preview. This 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.