PriceListWorkTypeModifier

IMPORTANT  The SOAP API entered a limited enhancement phase in Q4 2020. Access to version 1.6 will eventually be deactivated. At this time, there is no end-of-lifecycle date.

This entity is only used in Multi-currency databases. It describes Price List information associated with a WorkTypeModifier entity. A WorkTypeModifier entity modifies a given Work Type AllocationCode.

Entity details

You can also retrieve this information with the Web Services API call The getEntityInfo() SOAP API call.

Entity Name: PriceListWorkTypeModifier
Can Create:  
Can Update:
Can Query:
Can Delete:  
Can Have UDFs:  

Fields that cannot be queried

The following fields from this entity will return an error when queried.

  • ModifierType
  • ModifierValue

Conditions and requirements

General

  • If you don't have Multi-currency enabled and you try to write to the entity, you will receive an error.

Special field attributes

Field Conditions and Requirements
ModifierValue

On create() or update():

  • UsesInternalCurrencyPrice is an indicator of whether the WorkTypeModifier is set to "Use internal currency's modifier with exchange rate applied."
  • If this field's value equals true, then PriceListWorkTypeModifier.ModifierValue will return WorkTypeModifier.ModifierValue divided by the current Currency Exchange Rate; that is, the ModifierValue of the WorkTypeModifier entity with id equal to PriceListWorkTypeModifier.WorkTypeModifierID, divided by the current exchange rate of the Currency with id equal to PriceListWorkTypeModifier.CurrencyID.
  • In this case, PriceListWorkTypeModifier.ModifierType will also return the corresponding ModifierType value from the WorkTypeModifier entity with id equal to PriceListWorkTypeModifier.WorkTypeModifierID.

TIP  Modifier Types are described in the table below the following Field table.

UsesInternalCurrencyPrice

 
  • If the UsesInternalCurrencyPrice field is set to true, any supplied value for the ModifierValue field (or its equivalent) will be ignored by the system.
  • If the UsesInternalCurrencyPrice field is set to true, any existing value for the ModifierValue field will be cleared.
  • If the UsesInternalCurrencyPrice field is set to false, the ModifierValue field will be required, even though it is not required otherwise.

Field definitions

The following table describes the standard Autotask field objects for this entity.

  • To retrieve more detailed information specific to a particular Autotask implementation, use the Web Services API call The getFieldInfo() SOAP API call.
  • For information on entity UDFs, use getUDFInfo().
  • For String datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
  • LT indicates Local Term.

For more information about fields marked as picklists, review our Understanding picklists article.

Field Name Label Datatype Read Only Is Required Reference Name Picklist
CurrencyID Currency Id integer Currency  
id ID long    
ModifierType Modifier Type integer      
ModifierValue Value decimal  
Only when UsesInternal
CurrencyPrice=
false 		   
UsesInternalCurrencyPrice Uses Internal Currency Price boolean      
WorkTypeModifierID Work Type Modifier Id integer WorkTypeModifier  

Modifier Types for WorkTypeModifier

The WorkTypeModifier.ModifierType picklist contains the following modifier types.

Type Equals
0 Use Role Rate
1 Use Role Rate +/- [Value]
2 Use Role Rate multiplied by [Value]
3 Use Custom Rate of [Value]
4 Use Flat Rate of [Value]