ContractMilestones

The ContractMilestone entity describes a billing milestone for an Autotask Fixed Price Contract. Billing milestones describe tangible work or measured progress that must be completed before billing can take place, for example, "user approval on design specifications", or "ten workstations installed." A fixed price contract can have multiple billing milestones. In Autotask, you add and manage contract milestones from the Fixed Price Contract's Summary page.

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

Entity Path:

/atservicesrest/v1.0/ContractMilestones
Can Create:

Parent Entity:

Contracts

Can Update:
Can Query:
Can Delete:  
Can Have UDFs:  

Conditions and requirements

  • Resources with security levels that specify limited or no contract visibility cannot create, update, or query this entity.
  • ContractMilestone.billingCodeID must reference a Milestone type Allocation Code.
  • ContractMilestone.contractID must reference a Contract where ContractType is Fixed Price.
  • If ContractMilestone.isInitialPayment = False, ContractMilestone.status cannot = isBilled.
  • If ContractMilestone.isInitialPayment field = True, allow one Contract Milestone with status of "Billed" and one with status "Ready to Bill" for this Contract. That is, in Autotask, when creating a Fixed Price contract, you can specify whether the contract includes an initial payment. If yes, you can then optionally specify an amount received and/or an amount to be billed.

For each amount specified, a ContractMilestone is automatically created. An amount received automatically creates a ContractMilestone with status "Billed"; an amount to be billed automatically creates a ContractMilestone with status "Ready to Bill".

  • If ContractMilestone.status = isBilled, the field cannot be updated.
  • If the multi-currency Installed Module is enabled, the following fields will return the relevant Customer Currency values instead of the Internal Currency values: Amount.

The following fields will return the saved Internal Currency values: internalCurrencyAmount.

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
amount decimal      
billingCodeID integer     ProjectCharges  
contractID integer Contracts  
createDate datetime      
creatorResourceID integer   Resources  
dateDue datetime      
description string (250)        
id long    
internalCurrencyAmount
(Multi-currency module only)		 decimal      
isInitialPayment boolean      
status integer    
title string (100)      

Additional resources