PriceListWorkTypeModifiers

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 BillingCode.

NOTE  You can refer to the Online Help to find root and child access URLs of the entity you wish to query. Refer to Finding resource and child access URLs of REST API entities for more information.

Entity details

Entity Name: PriceListWorkTypeModifiers

Entity Path:

/atservicesrest/v1.0/PriceListWorkTypeModifiers
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.

NOTE  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 fields for this entity. Refer to the following articles for more information about working with these fields:

To learn how to query picklist endpoints, refer to Understanding picklists.

Notes

  • For string datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
  • LT indicates Local Term.
  • If this entity has child collections, they will appear in a Child collection access URLs or an Entity URLs and relationships drop-down in the Entity details section of this article.
  • You can call the /query/count/ endpoint of a resource to determine how many records a collection holds.
Field Name Datatype Read-Only Is Required Reference Name Picklist
currencyID integer Currencies  
id long    
modifierType integer      
modifierValue decimal  
Only when usesInternalCurrencyPrice=
false 		   
usesInternalCurrencyPrice boolean      
workTypeModifierID integer WorkTypeModifiers  

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]

Additional resources