ContractBillingRule

IMPORTANT  The SOAP API entered a limited enhancement phase in Q4 2020. Access to version 1.6 will be deactivated.

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

Entity details

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

Entity Name: ContractBillingRuleEntity
Can Create:
Can Update:
Can Query:
Can Delete:
Can Have UDFs:  

Conditions and requirements

General

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.

ExecutionMethod

This field determines how billing rules are executed. Options are:

  • Use System Setting
  • Automatic
  • Manual
ContractID This field must be supplied during create(). On update(), it is read-only.

Field definitions

Field Name Label Datatype Read Only Is Required Reference Name Picklist
Active Active boolean      
ContractID Contract ID integer Contract  
CreateChargesAsBillable Create Charges As Billable boolean      
DailyProratedCost Daily Prorated Cost decimal        
DailyProratedPrice Daily Prorated Price decimal        
DetermineUnits Determine Units integer    
EnableDailyProrating Enable Daily Prorating boolean      
EndDate End Date datetime        

ExecutionMethod

Execution Method

integer

 

 

 

id Contract Billing Rule ID long    
IncludeItemsInChargeDescription Include Items In Charge Description boolean      
InvoiceDescription Invoice Description string (500)        
MaximumUnits Maximum Units integer        
MinimumUnits Minimum Units integer        
ProductID Product ID integer Product  
StartDate Start Date datetime