Adding Transaction Fields to a Web Service Request for Contract Renewals

Contract Renewals uses some transactions (sales orders, in particular) as the basis for contract creation and renewal. When creating transactions using a web service, you must ensure that the fields being used by the Contract Renewals SuiteApp have a value in the web service request.

The following table lists the fields on a sales order that must be included in the web service request:

Field Internal ID	Field UI Label	Description	Required
Primary Information
entity	Bill To Customer	Enter the internal id of the customer.	Yes
custbody_end_user	End User	Enter the internal id of the customer.	Yes
custbody_order_type	Transaction Order Type	Enter the transaction order type: 1 – Contract-New 2 – Contract-Renewal 3 – Contract-Upsell 13 – Contract-Downsell	Yes
custbody_tran_term_in_months	Term	Enter the contract term in months. If a value is not supplied, a default value of 12 will be used.	No
startdate	Start Date	Enter the transaction start date.	Yes
enddate	End Date	Enter the transaction end date. If no value is supplied, the end date will be computed based on the start date and contract term.	No
custbody_renewal_terms	Renewal Terms	Enter the new term of the contract (in months) when it is renewed.	No
Item Subtab
item	Item	Enter the internal ID of the item to be added in the item sublist.	Yes
quantity	Quantity	Enter the quantity of the items to be added.	No
price	Price	Enter the price level used for the item: 1 – Use the base price. This is the default value. -1 – Use a custom price. If this option is used, you must also set a value for List Rate and Rate. Block Custom Price Level must also be set to 2 (No) to allow custom pricing. Internal ID of the price level created on the account.	No
custcol_list_rate	List Rate	Enter a value for the item list rate.	Yes (if custom price level is used) No (if non-custom price level is used)
custcol_inline_discount	Discount	Specify the discount percentage, if applicable. Enter a value from 0 to 100. Do not append the percent sign (%).	No
rate	Rate	Enter the rate for the item. The value should be equivalent to: [list_rate]*[term]*[discount]	Yes (if custom price level is used) No (if non-custom price level is used)
amount	Amount	This is the computed amount based on the rate and quantity.	No
custcol_swe_contract_item_term_months	Term	Enter the item term in months. By default, this is automatically populated based on the contract term.	No
custcol_swe_contract_start_date	Start Date	Enter the item start date. By default, this is automatically populated based on the transaction start date.	No
custcol_swe_contract_end_date	End Date	Enter the item end date. By default, this is automatically populated based on the transaction end date.	No
Options & Log Subtab
custbody_block_custom_price_level	Block Custom Price Level	Enter either 1 (Yes) or 2 (No). Yes – This blocks or does NOT allow items whose Item Category is selected or set For Custom Price Block preference (see Setting Up Contract Renewals Preferences) to be included or added to the sales order for web service processing. No – This allows items whose Item Category is selected or set For Custom Price Block preference (see Setting Up Contract Renewals Preferences) to be included or added to the sales order for web service processing.	Yes (if custom price level is used) No (if non-custom price level is used)
custbody_allow_custom_price_lvl_for_ms	Allow Custom Price Level for M/S Items	Enter either 1 (Yes) or 2 (No).	No
custbody_custom_price_is_annual_rate	Custom Price Entered is Annual Rate	Enter either true or false.	No

General Notices