Skip to main content

MGCLatticeSetSalesPriceRequest

Request contract for creating and posting a sales-price trade agreement (PriceDiscTable) with clean forward-only supersession. Describes the agreement tuple the classic PriceDisc engine keys on: legal entity + account (code type and relation) + item (code type and relation) + quantity break + currency and unit + effective date range, together with the unit price and price unit to set, optional site and warehouse dimensions, and a find-next flag. A repeated identical request is a no-op (outcome Unchanged); CorrelationId is echoed on the result.

Methods​

parmCorrelationId​

Gets or sets the correlation identifier for tracing the request across systems; echoed on the result.

  • Visibility: public
  • Returns: Guid The current value.
NameTypeOptionalDescription
_correlationIdGuidYesThe value to set.

parmLegalEntityId​

Gets or sets the legal entity (company) the agreement is created in. Blank uses the session company.

  • Visibility: public
  • Returns: DataAreaId The current value.
NameTypeOptionalDescription
_legalEntityIdDataAreaIdYesThe value to set.

parmAccountCode​

Gets or sets the account code type (Table, Group, or All) that scopes the customer side of the agreement.

  • Visibility: public
  • Returns: PriceDiscPartyCodeType The current value.
NameTypeOptionalDescription
_accountCodePriceDiscPartyCodeTypeYesThe value to set.

parmAccountRelation​

Gets or sets the account relation (customer account or price group) the agreement applies to.

  • Visibility: public
  • Returns: CustVendAC The current value.
NameTypeOptionalDescription
_accountRelationCustVendACYesThe value to set.

parmItemCode​

Gets or sets the product code type (Table, Group, or All) that scopes the item side of the agreement.

  • Visibility: public
  • Returns: PriceDiscProductCodeType The current value.
NameTypeOptionalDescription
_itemCodePriceDiscProductCodeTypeYesThe value to set.

parmItemRelation​

Gets or sets the item relation (item number or price group) the agreement applies to.

  • Visibility: public
  • Returns: ItemId The current value.
NameTypeOptionalDescription
_itemRelationItemIdYesThe value to set.

parmCurrencyCode​

Gets or sets the currency of the price. Required.

  • Visibility: public
  • Returns: CurrencyCode The current value.
NameTypeOptionalDescription
_currencyCodeCurrencyCodeYesThe value to set.

parmUnitId​

Gets or sets the unit of measure the price is quoted in. Empty defaults to the item's sales unit when ItemCode is Table.

  • Visibility: public
  • Returns: UnitOfMeasureSymbol The current value.
NameTypeOptionalDescription
_unitIdUnitOfMeasureSymbolYesThe value to set.

parmFromQty​

Gets or sets the quantity break the agreement applies from (the agreement's "From quantity").

  • Visibility: public
  • Returns: Qty The current value.
NameTypeOptionalDescription
_fromQtyQtyYesThe value to set.

parmUnitPrice​

Gets or sets the unit price to set on the agreement. Must be greater than zero unless AllowZeroPrice is set; a negative price is always refused.

  • Visibility: public
  • Returns: Price The current value.
NameTypeOptionalDescription
_unitPricePriceYesThe value to set.

parmAllowZeroPrice​

Gets or sets a value indicating whether a unit price of zero is intended (a free item). Without it a zero unit price - which is also what an omitted UnitPrice deserializes to - is refused.

  • Visibility: public
  • Returns: boolean The current value.
NameTypeOptionalDescription
_allowZeroPricebooleanYesThe value to set.

parmPriceUnit​

Gets or sets the price unit the unit price is quoted per (for example, per 100). Zero defaults to 1.

  • Visibility: public
  • Returns: PriceUnit The current value.
NameTypeOptionalDescription
_priceUnitPriceUnitYesThe value to set.

parmFromDate​

Gets or sets the date the agreement becomes effective.

  • Visibility: public
  • Returns: TransDate The current value.
NameTypeOptionalDescription
_fromDateTransDateYesThe value to set.

parmToDate​

Gets or sets the date the agreement expires. Empty means open-ended.

  • Visibility: public
  • Returns: TransDate The current value.
NameTypeOptionalDescription
_toDateTransDateYesThe value to set.

parmFindNext​

Gets or sets a value indicating whether find-next resolution chains to the next matching agreement.

  • Visibility: public
  • Returns: boolean The current value.
NameTypeOptionalDescription
_findNextbooleanYesThe value to set.

parmSiteId​

Gets or sets the optional inventory site pricing dimension.

  • Visibility: public
  • Returns: InventSiteId The current value.
NameTypeOptionalDescription
_siteIdInventSiteIdYesThe value to set.

parmWarehouseId​

Gets or sets the optional warehouse pricing dimension.

  • Visibility: public
  • Returns: InventLocationId The current value.
NameTypeOptionalDescription
_warehouseIdInventLocationIdYesThe value to set.

parmPreviewMode​

Gets or sets whether the request runs as a preview. setSalesPrice has no preview: a request with PreviewMode set is refused with ErrorCode PreviewUnsupported before anything runs.

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

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.

parmAccountRelationExternalKey​

Gets or sets the external system's key of the customer, in place of AccountRelation. Only valid when AccountCode is Table.

  • Visibility: public
  • Returns: MGCLatticeExternalKey The AccountRelationExternalKey value.
NameTypeOptionalDescription
_accountRelationExternalKeyMGCLatticeExternalKeyYesThe AccountRelationExternalKey value.

parmItemRelationExternalKey​

Gets or sets the external system's key of the released product, in place of ItemRelation. Only valid when ItemCode is Table.

  • Visibility: public
  • Returns: MGCLatticeExternalKey The ItemRelationExternalKey value.
NameTypeOptionalDescription
_itemRelationExternalKeyMGCLatticeExternalKeyYesThe ItemRelationExternalKey value.