MGCLatticeFixedAssetSplitRequestContract

Data contract for splitAsset: the fixed asset and book to split, the share to split off (a percentage or a quantity of the asset), the asset and book that receive it (an existing asset, or a new copy of the asset), the split date and the fixed asset journal name of the split journal.

Methods

new

Initializes a new instance of the MGCLatticeFixedAssetSplitRequestContract class.

• Visibility: public
• Returns: void

No parameters.

construct

Creates a new instance of the MGCLatticeFixedAssetSplitRequestContract class.

• Visibility: public
• Returns: MGCLatticeFixedAssetSplitRequestContract A new MGCLatticeFixedAssetSplitRequestContract instance.

No parameters.

parmCorrelationId

Gets or sets the correlation identifier for tracing the request across systems.

• Visibility: public
• Returns: Guid The 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: Guid The 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: DataAreaId The 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: UserId The 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 created or posted.

• Visibility: public
• Returns: boolean The current preview flag.

Name	Type	Optional	Description
_previewMode	boolean	Yes	The preview flag to set.

parmExternalSystem

Gets or sets the external system whose keys AssetIdExternalKey and ToAssetIdExternalKey hold.

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

Name	Type	Optional	Description
_externalSystem	MGCLatticeExternalSystemId	Yes	The ExternalSystem value.

parmAssetId

Gets or sets the fixed asset to split.

• Visibility: public
• Returns: AssetId The 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 to split, in place of AssetId.

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

Name	Type	Optional	Description
_assetIdExternalKey	MGCLatticeExternalKey	Yes	The AssetIdExternalKey value.

parmAssetBookId

Gets or sets the book to split.

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

Name	Type	Optional	Description
_assetBookId	AssetBookId	Yes	The AssetBookId value.

parmToAssetId

Gets or sets the existing fixed asset that receives the split; empty creates a new fixed asset as a copy of the asset to split, with its books, none acquired.

• Visibility: public
• Returns: AssetId The ToAssetId value.

Name	Type	Optional	Description
_toAssetId	AssetId	Yes	The ToAssetId value.

parmToAssetIdExternalKey

Gets or sets the external system's key of the fixed asset that receives the split, in place of ToAssetId.

• Visibility: public
• Returns: MGCLatticeExternalKey The ToAssetIdExternalKey value.

Name	Type	Optional	Description
_toAssetIdExternalKey	MGCLatticeExternalKey	Yes	The ToAssetIdExternalKey value.

parmToAssetBookId

Gets or sets the book of the receiving asset; empty uses the same book as AssetBookId.

• Visibility: public
• Returns: AssetBookId The ToAssetBookId value.

Name	Type	Optional	Description
_toAssetBookId	AssetBookId	Yes	The ToAssetBookId value.

parmPercent

Gets or sets the percentage of the book's values to split off, greater than 0 and at most 100. Send either Percent or Quantity.

• Visibility: public
• Returns: Percent The Percent value.

Name	Type	Optional	Description
_percent	Percent	Yes	The Percent value.

parmQuantity

Gets or sets the quantity of the asset to split off, at most the asset's quantity: the split moves that share of the book's values and moves the quantity to the receiving asset. Send either Percent or Quantity.

• Visibility: public
• Returns: AssetQuantity The Quantity value.

Name	Type	Optional	Description
_quantity	AssetQuantity	Yes	The Quantity value.

parmSplitDate

Gets or sets the split date; empty uses today.

• Visibility: public
• Returns: TransDate The SplitDate value.

Name	Type	Optional	Description
_splitDate	TransDate	Yes	The SplitDate value.

parmJournalNameId

Gets or sets the fixed asset journal name the split journal is created with; its posting layer must be the one of the books.

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

Name	Type	Optional	Description
_journalNameId	LedgerJournalNameId	Yes	The JournalNameId value.