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:
MGCLatticeFixedAssetTransferRequestContractA new MGCLatticeFixedAssetTransferRequestContract instance.
No parameters.
parmCorrelationId
Gets or sets the correlation identifier for tracing the request across systems.
- Visibility:
public - Returns:
GuidThe CorrelationId value.
| Name | Type | Optional | Description |
|---|---|---|---|
_correlationId | Guid | Yes | The CorrelationId value. |
parmRequestId
Gets or sets the unique request identifier for idempotency.
- Visibility:
public - Returns:
GuidThe RequestId value.
| Name | Type | Optional | Description |
|---|---|---|---|
_requestId | Guid | Yes | The RequestId value. |
parmLegalEntityId
Gets or sets the legal entity (company) in which to execute the operation.
- Visibility:
public - Returns:
DataAreaIdThe LegalEntityId value.
| Name | Type | Optional | Description |
|---|---|---|---|
_legalEntityId | DataAreaId | Yes | The LegalEntityId value. |
parmUserContext
Gets or sets the user context under which the operation executes.
- Visibility:
public - Returns:
UserIdThe UserContext value.
| Name | Type | Optional | Description |
|---|---|---|---|
_userContext | UserId | Yes | The 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:
booleanThe current preview flag.
| Name | Type | Optional | Description |
|---|---|---|---|
_previewMode | boolean | Yes | The preview flag to set. |
parmExternalSystem
Gets or sets the external system whose key AssetIdExternalKey holds.
- Visibility:
public - Returns:
MGCLatticeExternalSystemIdThe ExternalSystem value.
| Name | Type | Optional | Description |
|---|---|---|---|
_externalSystem | MGCLatticeExternalSystemId | Yes | The ExternalSystem value. |
parmAssetId
Gets or sets the fixed asset to transfer.
- Visibility:
public - Returns:
AssetIdThe AssetId value.
| Name | Type | Optional | Description |
|---|---|---|---|
_assetId | AssetId | Yes | The AssetId value. |
parmAssetIdExternalKey
Gets or sets the external system's key of the fixed asset, in place of AssetId.
- Visibility:
public - Returns:
MGCLatticeExternalKeyThe AssetIdExternalKey value.
| Name | Type | Optional | Description |
|---|---|---|---|
_assetIdExternalKey | MGCLatticeExternalKey | Yes | The 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:
AssetBookIdThe AssetBookId value.
| Name | Type | Optional | Description |
|---|---|---|---|
_assetBookId | AssetBookId | Yes | The 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:
ListThe financial dimension values list.
| Name | Type | Optional | Description |
|---|---|---|---|
_dimensions | List | Yes | The financial dimension values list. |
parmLocationId
Gets or sets the fixed asset location the asset moves to; empty keeps the location.
- Visibility:
public - Returns:
AssetLocationIdThe LocationId value.
| Name | Type | Optional | Description |
|---|---|---|---|
_locationId | AssetLocationId | Yes | The LocationId value. |
parmTransferDate
Gets or sets the transfer date; empty uses today.
- Visibility:
public - Returns:
TransDateThe TransferDate value.
| Name | Type | Optional | Description |
|---|---|---|---|
_transferDate | TransDate | Yes | The TransferDate value. |
parmComment
Gets or sets the transfer comment, written to the transfer history and the transfer transactions.
- Visibility:
public - Returns:
TransferCommentThe Comment value.
| Name | Type | Optional | Description |
|---|---|---|---|
_comment | TransferComment | Yes | The Comment value. |