InstalledProductBillingProductAssociation

IMPORTANT  The SOAP API entered a limited enhancement phase in Q4 2020. Access to version 1.6 will eventually be deactivated. At this time, there is no end-of-lifecycle date.

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

Entity details

You can also retrieve this information with the Web Services API call The getEntityInfo() SOAP API call.

Entity Name: InstalledProductBillingProductAssociationEntity
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 InstalledProductBillingProductAssociations for Contact or InstalledProduct 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.
InstalledProductID This field must be supplied during create(). On update(), it is read-only.

Field definitions

The following table describes the standard Autotask field objects for this entity.

  • To retrieve more detailed information specific to a particular Autotask implementation, use the Web Services API call The getFieldInfo() SOAP API call.
  • For information on entity UDFs, use getUDFInfo().
  • For String datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
  • LT indicates Local Term.

For more information about fields marked as picklists, review our Understanding picklists article.

Field Name Label Datatype Read Only Is Required Reference Name Picklist
BillingProductID Billing Product ID integer Product  
EffectiveDate Effective Date datetime      
ExpirationDate Expiration Date datetime        
id Asset Billing Product Association ID long    
InstalledProductID Asset ID integer InstalledProduct