ContractBillingRules

This entity describes contract billing rules that generate charges that allow you to bill your customer by the end user or by the asset.

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

Entity Path:

/atservicesrest/v1.0/ContractBillingRules

Parent Entity:

Contracts

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

Conditions and requirements

General

  • This entity interacts with the Products entity. The Products entity can have no more than 100 UDFs. Refer to UserDefinedFieldDefinitions for more information.
  • System products cannot be updated.

Special field attributes

Field Conditions and Requirements
productID This field must be supplied during create. On update, it is read-only.
The selected productID must be active during a create call and it must reference a product with a billingType not equal to Standard.
contractID This field must be supplied during create. On update, it is read-only.

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
contractID integer Contracts  
createChargesAsBillable boolean      
dailyProratedCost decimal        
dailyProratedPrice decimal        
determineUnits integer    
endDate datetime        

executionMethod

integer

 

 

 

id long    
includeItemsInChargeDescription boolean      
invoiceDescription string (500)        
isActive boolean      
isDailyProrationEnabled boolean      
maximumUnits integer        
minimumUnits integer        
productID integer Products  
startDate datetime      

Additional resources