Skip to main content

MGCLatticeFixedAssetDisposalRequestContract

Data contract for fixed asset disposal requests containing AssetId, AssetBookId, JournalNameId, IsSale flag, SaleAmount, and DisposalDate.

Methods​

new​

Initializes a new instance of the MGCLatticeFixedAssetDisposalRequestContract class.

  • Visibility: public
  • Returns: void

No parameters.

construct​

Creates a new instance of the MGCLatticeFixedAssetDisposalRequestContract class.

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

parmOffsetMainAccountId​

Gets or sets the counter-account for the sale proceeds of a sale disposal (IsSale). Without an offset the disposal voucher cannot balance, so a sale disposal could never post.

  • Visibility: public
  • Returns: str The offset main account id.
NameTypeOptionalDescription
_offsetMainAccountIdstrYesThe offset main account id.

parmJournalNameId​

Gets or sets the journal name identifier that determines the journal type and default settings.

  • Visibility: public
  • Returns: LedgerJournalNameId The JournalNameId value.
NameTypeOptionalDescription
_journalNameIdLedgerJournalNameIdYesThe JournalNameId value.

parmAssetId​

Gets or sets the fixed asset identifier.

  • Visibility: public
  • Returns: str The AssetId value.
NameTypeOptionalDescription
_assetIdstrYesThe AssetId value.

parmAssetBookId​

Gets or sets the fixed asset depreciation book identifier.

  • Visibility: public
  • Returns: str The AssetBookId value.
NameTypeOptionalDescription
_assetBookIdstrYesThe AssetBookId value.

parmIsSale​

Gets or sets whether the disposal is a sale (true) or scrap (false).

  • Visibility: public
  • Returns: boolean True if the disposal is a sale; otherwise, false.
NameTypeOptionalDescription
_isSalebooleanYesTrue if the disposal is a sale; otherwise, false.

parmSaleAmount​

Gets or sets the sale proceeds amount for the asset disposal.

  • Visibility: public
  • Returns: real The SaleAmount value.
NameTypeOptionalDescription
_saleAmountrealYesThe SaleAmount value.

parmCurrencyCode​

Gets or sets the currency code for the transaction.

  • Visibility: public
  • Returns: CurrencyCode The CurrencyCode value.
NameTypeOptionalDescription
_currencyCodeCurrencyCodeYesThe CurrencyCode value.

parmDisposalDate​

Gets or sets the asset disposal effective date.

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

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.

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 created or posted.

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