CONTRACT

Overview


Allowed Functions

Create Update Retrieve Delete Upsert
YES YES YES YES YES 

 

Fields

Field Data Type Properties Description
StartDate date   Date when the contract rates associated with the contract takes effect. 
EndDate date   Date of the last day when the contract rates associated with the contract are no longer in effect.
AccountId string   ID of the account/customer that the contract is associated to. 
AccountObj ACCOUNT   Alternative to the ID, the brmObject of the account/customer that the contract is associated to. 
ContractNumber string   Indicates the unique contract identifier.
ContractStatus string  

System field. No value is needed to be passed here. This indicates the status of the contract. Value can either be:

  • ACTIVE
  • EXPIRED
OnEndDate string  

Indicates the behavior of the contract when the end date is reached. Valid values are:

  • Renew
  • Terminate
RateClassId string   Allows the selection of an existing rate class in the system to serve as a starting point for the contract rates.
RateClassObj RATE_CLASS   An alternative to passing the rate class ID, the brmObject of the rate class that will be used as the starting point/template of the contract.



Have more questions? Submit a request

Comments

Powered by Zendesk