|
PriceBookEntry
An object representing a product associated with a price/expense book.
Supported API Calls: List | Get | Add | Update | Delete
Object Properties
|
Property |
Type |
Description |
|
Id |
integer |
A unique ID representing the PriceBookEntry object. When adding a new PriceBookEntry the value must be 0. |
|
ProductId |
integer |
ID of the product associated with the price/expense book. This value is optional. |
|
ProductName |
string (100) |
Name of the associated product. |
|
PriceBookId |
integer |
ID of the parent price book. |
|
PriceBookName |
string (100) |
Name of the parent price/expense book. |
|
UnitPrice |
double |
The price of the product when used in the price/expense book. This value is optional. |
|
IsActive |
boolean |
Flag indicating this product is currently available via the price/expense book. |
|
UseStandardPrice |
boolean |
Flag to indicate the price/expense book should use the price from the associated product object's DefaultPrice field. |
|
PricePercentage |
double |
The product's actual percentage price calculation on the parent product object's PricePercentage field. This value is optional. |
|
Type |
string (100) |
Indicates whether it's a pricebook or expense book. Values are: product or expense. |
|
Uom |
string (100) |
The product's Unit of Measurement from the product object's UOM field. |
|
DefaultPrice |
float |
The product's price. This value is optional. |
|
CanUseQuantitySchedule |
boolean |
Flag to indicate this product is billed via a quantity schedule. |
|
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 |
|
ProductDesc |
string (100) |
Description of the product. |
List
Description
Returns a list of products added to the pricebook.
URL
https://{company}.bluecamroo.com/api/pricebookentry/list?priceBookId={priceBookId}
HTTP Method
GET
Data Return
Returns a list of products for the parent price/expense book in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
401: Not authorized (you need to log in)
Get
Returns the details of a particular price/expense book product.
Description
Returns the details of the pricebook
URL
https://{company}.bluecamroo.com/api/pricebookentry/get/{id}
HTTP Method
GET
Parameters
None
Data Return
Returns the pricebookentry 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 the product to the price/expense book.
URL
https://{company}.bluecamroo.com/api/pricebookentry/add
HTTP Method
POST
Parameters
A pricebookentry object
Data Return
Returns the pricebookentry 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 pricebookentry in a particular price/expense book.
URL
https://{company}.bluecamroo.com/api/pricebookentry/update
HTTP Method
PUT
Parameters
A pricebookentry object
Data Return
Returns the pricebookentry 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
Removes the specified product from the pricebook.
URL
https://{company}.bluecamroo.com/api/pricebookentry/delete/{id}
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)
|