ChangeOrderCharges

This entity describes a cost associated with a Change Order to an Autotask Project. A cost is a billing item for products or materials. Cost items can be billable or non-billable. Billable cost items appear in Approve & Post.

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: ChangeOrderCharges

Entity Path:

/atservicesrest/v1.0/ChangeOrderCharges
Can Create:
Can Update:
Only when Billing = false
Can Query:
Can Delete:
Only when Billing = false
Can Have UDFs:  

Conditions and requirements

General

  • Change Order Costs cannot be created for tasks on baseline projects.
  • If the Change Order Cost is billed, then only the changeOrderHours field can be updated.
  • create, update, delete, and query require Security Level permission to access the Projects module and the user must have access to the specific project.

Special field attributes

Field Conditions and Requirements

billableAmount

If the Multi-currency Installed Module is enabled, this field will return the relevant Customer Currency values instead of the Internal Currency values.

billingCodeID

 

The billingCodeID must reference a Material Cost Code.

ChangeOrderCharge must have either a productID or billingCodeID.

If no billing code ID is supplied but a product ID is, then we default the billingCodeID value to the one associated with the product.

contractServiceID

contractServiceBundleID

Only contractServiceID or contractServiceBundleID can be set, not both.

The contractServiceID/contractServiceBundleID must be associated to the contract on the project. If you pass in contractServiceID or contractServiceBundleID, and the Contract they are associated with isn't associated with the Project your taskID is associated with, you will get an error.

extendedCost

This entity field will return no information if the user account making the query does not have sufficient privileges to view cost data in the Autotask UI. Additionally, if an update request does not have the necessary permissions, the API will ignore the call's values for the field even if they are blank or would be otherwise required.

internalCurrencyBillableAmount

If the Multi-currency Installed Module is enabled, this field will return the saved Internal Currency values.

internalCurrencyUnitPrice

If the Multi-currency Installed Module is enabled, this field will return the saved Internal Currency values.

productID

 

ProjectCharge must have either a productID or billingCodeID.

If no allocation code id is supplied but a product id is, then we default the billingCodeID value to the one associated with the product.

Cannot be changed during an update

taskID

Cannot be changed during an update

Must reference a Task and not an Issue

Can only be associated with change order charges

unitCost

This entity field will return no information if the user account making the query does not have sufficient privileges to view cost data in the Autotask UI. Additionally, if an update request does not have the necessary permissions, the API will ignore the call's values for the field even if they are blank or would be otherwise required.

unitCost, unitPrice

If a unitCost/unitPrice is not supplied, then it will default to that on the product.

If the allocation code id value is supplied and the unitCost or unitPrice is not supplied then we use the following logic to default the values for unitCost, unitPrice, and isBillableToCompany:

If the contract on the project (if applicable) has contract cost defaults, then use the unit cost/price of those defaults. Otherwise, we use the material cost code's unit cost/price. The fields values will only be defaulted if a value was not provided for them (if you supply unit cost but no unit price, then we only default the unit price value and the supplied unit cost will remain).

If the Multi-currency Installed Module is enabled, these fields will return the relevant Customer Currency values instead of the Internal Currency values.

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
billableAmount decimal      
billingCodeID integer     ProjectCharges  
changeOrderHours decimal        

chargeType

integer

 

 

contractServiceBundleID integer     ContractServiceBundles  
contractServiceID integer     ContractServices  
chargeType integer    

createDate

datetime

 

 

 
creatorResourceID integer   Resources  
datePurchased datetime      
description string (2000)        
extendedCost decimal      
id long    
internalCurrencyBillableAmount (Multi-currency module only) decimal      
internalCurrencyUnitPrice (Multi-currency module only) decimal      
internalPurchaseOrderNumber string (50)        
isBillableToCompany boolean        
isBilled boolean      
name string (100)      
notes string (2000)        
organizationalLevelAssociationID integer   OrganizationalLevelAssociations  
productID integer     Products  
purchaseOrderNumber string (50)        
status integer    
statusLastModifiedBy integer   Resources  
statusLastModifiedDate datetime      
taskID integer   Tasks  
unitCost decimal        
unitPrice decimal        
unitQuantity decimal      

Additional resources