ConfigurationItemBillingProductAssociations

This entity describes the mapping of the Asset (Configuration Item) to the contract billing rule.

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

Entity Path:

/atservicesrest/v1.0/ConfigurationItemBillingProductAssociations
Parent Entity: ConfigurationItems
Can Create:
Can Update:
Can Query:
Can Delete:
Can Have UDFs:  

Conditions and requirements

General

  • If Autotask receives a create, update, or delete request for this entity and its corresponding module is unavailable, the API will return the error message, "The logged in Resource does not have the adequate permissions to update this entity type." For more information about installed modules, refer to our Modules article.
  • If the User Based Billing feature is turned off, the API will not automatically create ContactBillingProductAssociations or ConfigurationItemBillingProductAssociations for Contact or ConfigurationItem entities created by vendor integrations associated with default billing products in Admin - Integration Center.

Special field attributes

Field Conditions and Requirements
billingProductID This field must be supplied during create. On update, it is read-only.
configurationItemID 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
billingProductID integer Products  
configurationItemID integer ConfigurationItems  
effectiveDate datetime      
expirationDate datetime        
id long    

Additional resources