Skip to main content

MGCLatticeFixedAssetTransferRequestContract

Data contract for transferAsset: the fixed asset (optionally one of its books), the financial dimensions it moves to, its new location, the transfer date and a comment.

Methods​

new​

Initializes a new instance of the MGCLatticeFixedAssetTransferRequestContract class.

  • Visibility: public
  • Returns: void

No parameters.

construct​

Creates a new instance of the MGCLatticeFixedAssetTransferRequestContract class.

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

  • 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 to transfer.

  • 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 one book to transfer; empty transfers every open or closed book of the asset that has a posting layer, as the Transfer asset page lists them.

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

parmDimensions​

Gets or sets the financial dimension values the asset moves to. They replace the same dimensions of each book's current default dimensions; the other dimensions keep their values.

  • Visibility: public
  • Returns: List The financial dimension values list.
NameTypeOptionalDescription
_dimensionsListYesThe financial dimension values list.

parmLocationId​

Gets or sets the fixed asset location the asset moves to; empty keeps the location.

  • Visibility: public
  • Returns: AssetLocationId The LocationId value.
NameTypeOptionalDescription
_locationIdAssetLocationIdYesThe LocationId value.

parmTransferDate​

Gets or sets the transfer date; empty uses today.

  • Visibility: public
  • Returns: TransDate The TransferDate value.
NameTypeOptionalDescription
_transferDateTransDateYesThe TransferDate value.

parmComment​

Gets or sets the transfer comment, written to the transfer history and the transfer transactions.

  • Visibility: public
  • Returns: TransferComment The Comment value.
NameTypeOptionalDescription
_commentTransferCommentYesThe Comment value.