fcSDK Documentation
CreateContractLineItem(CreateContractLineItemSetup,IDbTransaction) Method

Setup object for API invocation.
Database transaction under which the API will be invoked.
Used to create quote/contract line items. This overload takes a setup object and a database transaction.
Syntax
'Declaration
 
Public Overloads Function CreateContractLineItem( _
   ByVal setupParam As CreateContractLineItemSetup, _
   ByVal transaction As IDbTransaction _
) As ToolkitResult

Parameters

setupParam
Setup object for API invocation.
transaction
Database transaction under which the API will be invoked.

Return Value

A ToolkitResult instance with no properties set. The properties (Objid, IDNum, etc.) are not relevant to this API.
Remarks

The API requires that a valid quote already exist, and that it have at least one valid schedule. In addition, the supplied part/revision must have a price defined for it in the schedule, or you must provide an override.

The API will create a line item, add it to the proper contract/quote, and adjust all of the totals. In addition, the schedule adjustments (if any) for the schedule of the line item will be recalculated, given the new schedule totals.

 The API does not do a few other items in the base GUI function. By and large, they are expected to be supplied with other API calls. For example, line item adjustments are not part of this API. If they are required, the line should be created, and then the adjustment should be applied. Parent/child line items are not provided for in the default API. Also, proration (ClearContracts) is currently hard-coded.

Example
Developer Walkthrough - Transaction support

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

Reference

ContractsToolkit Class
ContractsToolkit Members
Overload List

 

 


© 2010 Dovetail Software, Inc. - All rights reserved.
- Clarify, Amdocs, and related products and names are copyright and trademark of Amdocs, Inc.
- .NET, Visual Studio.NET, C#, Visual Basic and related products are trademark of Microsoft corporation.

Send comments on this topic.