WS_Contract
Web Service to create contracts
The following operations are supported. For a formal definition, please review the Service Description.
-
AddContractAttachment
Add attachment to contract header. Company Code [2 characters] User ID [10 characters unpadded] Contract ID Attachment File Name Attachment Data Attachment NoteTrue or False indicating success -
AddContractNote
Add note to contract header. Company Code [2 characters] User ID [10 characters unpadded] Contract ID NoteReturns ID of created contract note, -1 if failure -
CreateContract
Creates a contract from the provided contract object. Company Code [2 characters] Contract object to create: TxContract Required Fields: Number (Customer and Site) or (Customer and ProspectSite) or (Prospect and ProspectSite) Type (New Contract = N, Renewal = R) CreationDate EffectiveDate StartDate Info: SalesRep (Set to salesrep for WEB_USER if null) Unused: Id (must be 0) Creation Date Status (Default first status) RenewFrom (must be null) CreateUser (Default WEB_USER) TxContractDetail Required Fields: Type (Service Type) UnitOfMeasure Format: ScheduledDays (0101101 starting from sunday -> saturday. (1 = scheduled, 0 = not scheduled)) Unused: Id Link TxContractRate Required Fields: Column Number Unused: Id Detail Link Column LinkContract ID for created contract -
CreateProspect
Create Prospect, using Authentication Key. Login Company Code[2 characters]; Prospect Name; Address; City; State/Province[2 characters short code for state/province]; Postal Code or Zip Code[eg: Canada N1N1N1, USA 12345-1234]; Phone[eg: 1234567890]; Fax[eg: 1234567890]; Contact; Contact Email;Return: Propsect ID [int] -
CreateProspectSiteWithParsedAddress
Create Prospect Site With Parsed Address, using Authentication Key; Login Company Code[2 characters]; Prospect ID[if the site belong to a customer, then 0]; Customer ID[if the site belong to a prospect, then 0]; Prospect Name; Address; City; State/Province[2 characters short code for state/province]; Postal Code or Zip Code[eg: Canada N1N1N1, USA 12345-1234]; Phone[eg: 1234567890]; Fax[eg: 1234567890]; Contact; Contact Email; Parse Address- Address Num [int]; Parse Address- Unit; Parse Address- Pref; Parse Address- Direction; Parse Address- Street;Return: Propsect Site ID -
CreateProspectSiteWithoutParsedAddress
Create Prospect Site Without Parsed Address, using Authentication Key; Login Company Code[2 characters]; Prospect ID[if the site belong to a customer, then 0]; Customer ID[if the site belong to a prospect, then 0]; Prospect Name; Address; City; State/Province[2 characters short code for state/province]; Postal Code or Zip Code[eg: Canada N1N1N1, USA 12345-1234]; Phone[eg: 1234567890]; Fax[eg: 1234567890]; Contact; Contact Email;Return: Propsect Site ID [int] -
GetContract
Get contract object for given contract ID. Login Company Code[2 characters] Contract ID [int] Get contract for renewalContract object for given contract ID -
GetContractLegal
Get the latest contract legal before the time stamp, using Authentication Key. Company Code [2 characters] Time stamp (mm/dd/yyyy)Returns contract legal text in Richtext format(rtf) -
GetContractRateColumnSettingForComp
Get custom contract columns. Company Code [2 characters]Returns additional contract columns to be added to the contract detail CONTCOLSETUP_NUMB Column Number CONTCOLSETUP_NAME Column Name CONTCOLSETUP_TYPE Column Type (P = Period, M = Material, A = Activity) CONTCOLSETUP_CAPTYPE Weight Cap Type (null = None, 1 = max, 0 = min)
Field Name Description