Skip to main content

MGCLatticeSalesReturnCreditRequestContract

Data contract for sales return order credit note requests containing SalesOrderId and PostingDate.

Methods​

new​

Initializes a new instance of the MGCLatticeSalesReturnCreditRequestContract class.

  • Visibility: public
  • Returns: void

No parameters.

construct​

Creates a new instance of the MGCLatticeSalesReturnCreditRequestContract class.

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

parmSalesOrderId​

Gets or sets the return order number (a sales order of type Returned order).

  • Visibility: public
  • Returns: SalesId The SalesOrderId value.
NameTypeOptionalDescription
_salesOrderIdSalesIdYesThe SalesOrderId value.

parmPostingDate​

Gets or sets the posting date for the journal entry.

  • Visibility: public
  • Returns: TransDate The PostingDate value.
NameTypeOptionalDescription
_postingDateTransDateYesThe PostingDate 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.

parmSalesOrderIdExternalKey​

Gets or sets the external system's key of the return order, in place of SalesOrderId.

  • Visibility: public
  • Returns: MGCLatticeExternalKey The SalesOrderIdExternalKey value.
NameTypeOptionalDescription
_salesOrderIdExternalKeyMGCLatticeExternalKeyYesThe SalesOrderIdExternalKey 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 the error code PreviewUnsupported and nothing is created or posted.

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