|
LineItem
An object representing a product/service added to a project or an opportunity.
Supported API Calls: List | Get | Add | Update | Delete
Object Properties
|
Property |
Type |
Description |
|
Id |
integer |
A unique ID representing the LineItem object. When adding a new LineItem the value must be 0. |
|
ParentId |
integer |
ID of the parent object. |
|
ParentObject |
string (100) |
Name of the parent object type. Values are Project or Opportunity. |
|
ProductId |
integer |
The ID of the product that represents the line item. |
|
PriceBookEntryId |
integer |
ID of the product as a price book entry. |
|
Description |
string (100) |
Product description |
|
Quantity |
float |
The quantity for the Edit Product Info's Quantity field. Optional. This value can be null. |
|
UnitPrice |
float |
The price figure for the Edit Product Info's Unit Price field. Optional. This value can be null. |
|
TotalPrice |
float |
Stores the total price. |
|
IsStageBilling |
boolean |
Flag to indicate the item is stage billed. |
|
CurrencyIsoCode |
string (100) |
Three letter currency code displayed on Edit Product Info dialog box. |
|
ProductName |
string (100) |
Name of the product. |
|
CanUseQuantitySchedule |
boolean |
Flag to indicate if the line item is billed using a quantity schedule. |
|
UseStandardPrice |
boolean |
Flag to indicate the line item should use the product's default price. |
|
NumberOfQuantityInstallment |
integer |
If using a quantity schedule, how many installments. This value is optional. |
|
QuantityInstallmentPeriod |
string (100) |
If a repeating payment, the period. Values are: daily, weekly, monthly, quarterly, yearly. |
|
QuantityScheduleType |
string (100) |
The kind of billing schedule. Values are repeat or divide. |
|
QuantityInstallmentInterval |
integer |
Number of installment payments |
List
Description
Returns a list of products associated with the Project.
URL
https://{company}.bluecamroo.com/api/LineItem/list?ProjectId={ProjectId}
HTTP Method
GET
Parameters
None
Data Return
Returns the list of products in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
401: Not authorized (you need to log in)
Get
Description
Returns details for the line item for the specified Project.
URL
https://{company}.bluecamroo.com/api/LineItem/get/{id}?ProjectId={ProjectId}
HTTP Method
GET
Parameters
None
Data Return
Returns the LineItem object in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Add
Description
Adds a product to a Project.
URL
https://{company}.bluecamroo.com/api/LineItem/add
HTTP Method
POST
Parameters
A LineItem object
Data Return
Returns the LineItem object in the requested format (e.g., JSON or XML)
HTTP Return Status Code
201: Created
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Update
Description
Updates a Project's product.
URL
https://{company}.bluecamroo.com/api/LineItem/update
HTTP Method
PUT
Parameters
A LineItem object
Data Return
Returns the LineItem object in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Delete
Description
Deletes the product associated with the Project.
URL
https://{company}.bluecamroo.com/api/LineItem/{id}?ProjectId={ProjectId}
HTTP Method
DELETE
Parameters
None
Data Return
None
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
|