Skip to main content

MGCLatticeFixedAssetReversalRequestContract

Data contract for reverseAssetTransaction: the fixed asset and book, the voucher of the transaction to reverse (and its date when the voucher has several), the reversal date and the financial reason.

Methods​

new​

Initializes a new instance of the MGCLatticeFixedAssetReversalRequestContract class.

  • Visibility: public
  • Returns: void

No parameters.

construct​

Creates a new instance of the MGCLatticeFixedAssetReversalRequestContract class.

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

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 reversed.

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

parmExternalSystem​

Gets or sets the external system whose key AssetIdExternalKey holds.

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

parmAssetId​

Gets or sets the fixed asset of the transaction to reverse.

  • Visibility: public
  • Returns: AssetId The AssetId value.
NameTypeOptionalDescription
_assetIdAssetIdYesThe AssetId value.

parmAssetIdExternalKey​

Gets or sets the external system's key of the fixed asset, in place of AssetId.

  • Visibility: public
  • Returns: MGCLatticeExternalKey The AssetIdExternalKey value.
NameTypeOptionalDescription
_assetIdExternalKeyMGCLatticeExternalKeyYesThe AssetIdExternalKey value.

parmAssetBookId​

Gets or sets the book of the transaction to reverse.

  • Visibility: public
  • Returns: AssetBookId The AssetBookId value.
NameTypeOptionalDescription
_assetBookIdAssetBookIdYesThe AssetBookId value.

parmVoucher​

Gets or sets the voucher of the fixed asset transaction to reverse.

  • Visibility: public
  • Returns: Voucher The Voucher value.
NameTypeOptionalDescription
_voucherVoucherYesThe Voucher value.

parmTransactionDate​

Gets or sets the date of the transaction to reverse; needed only when the voucher has transactions of the book on several dates.

  • Visibility: public
  • Returns: TransDate The TransactionDate value.
NameTypeOptionalDescription
_transactionDateTransDateYesThe TransactionDate value.

parmReversalDate​

Gets or sets the date the reversal posts on; empty uses today. It cannot be before the transaction's date.

  • Visibility: public
  • Returns: TransDate The ReversalDate value.
NameTypeOptionalDescription
_reversalDateTransDateYesThe ReversalDate value.

parmReasonCode​

Gets or sets the financial reason code written on the reversal.

  • Visibility: public
  • Returns: ReasonCode The ReasonCode value.
NameTypeOptionalDescription
_reasonCodeReasonCodeYesThe ReasonCode value.

parmReasonComment​

Gets or sets the reason comment written on the reversal.

  • Visibility: public
  • Returns: ReasonComment The ReasonComment value.
NameTypeOptionalDescription
_reasonCommentReasonCommentYesThe ReasonComment value.