MGCLatticeItemCostCalculationRequestContract
Data contract for calculating item costs in a costing version (the costing version's Calculation): the costing version, the site, the calculation date, an optional list of items, and the standard header fields.
Methods
new
Initializes a new instance of the MGCLatticeItemCostCalculationRequestContract class.
- Visibility:
public - Returns:
void
No parameters.
construct
Creates a new instance of the MGCLatticeItemCostCalculationRequestContract class.
- Visibility:
public - Returns:
MGCLatticeItemCostCalculationRequestContractA new MGCLatticeItemCostCalculationRequestContract 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 whose costing version is calculated.
- Visibility:
public - Returns:
DataAreaIdThe LegalEntityId value.
| Name | Type | Optional | Description |
|---|---|---|---|
_legalEntityId | DataAreaId | Yes | The LegalEntityId value. |
parmUserContext
Gets or sets the calling system's user context (informational).
- Visibility:
public - Returns:
UserIdThe UserContext value.
| Name | Type | Optional | Description |
|---|---|---|---|
_userContext | UserId | Yes | The UserContext value. |
parmCostingVersionId
Gets or sets the costing version whose item costs are calculated (required).
- Visibility:
public - Returns:
CostingVersionIdThe CostingVersionId value.
| Name | Type | Optional | Description |
|---|---|---|---|
_costingVersionId | CostingVersionId | Yes | The CostingVersionId value. |
parmSiteId
Gets or sets the site the costs are calculated for. Required when the costing version is not restricted to a site; when it is, leave it empty or send the version's site.
- Visibility:
public - Returns:
InventSiteIdThe SiteId value.
| Name | Type | Optional | Description |
|---|---|---|---|
_siteId | InventSiteId | Yes | The SiteId value. |
parmCalculationDate
Gets or sets the calculation date, which is also the from date of the pending prices. Empty uses the costing version's fixed date when it has one, else today; a costing version with a fixed date accepts only that date.
- Visibility:
public - Returns:
TransDateThe CalculationDate value.
| Name | Type | Optional | Description |
|---|---|---|---|
_calculationDate | TransDate | Yes | The CalculationDate value. |
parmItemIds
Gets or sets the items whose costs are calculated; empty calculates every item of the legal entity, as the costing version's Calculation does.
- Visibility:
public - Returns:
ListThe ItemIds list.
| Name | Type | Optional | Description |
|---|---|---|---|
_itemIds | List | Yes | A list of item numbers (str). |
parmPreviewMode
Gets or sets preview mode. The operation has no preview, so a request with PreviewMode set is refused.
- Visibility:
public - Returns:
booleanThe PreviewMode value.
| Name | Type | Optional | Description |
|---|---|---|---|
_previewMode | boolean | Yes | The PreviewMode value. |