|
Product
An object representing a product or expense in BlueCamroo.
Supported API Calls: List | Get | Add | Update | Delete
Object Properties
|
Property |
Type |
Description |
|
Id |
integer |
A unique ID representing the Product object. When adding a new Product the value must be 0. |
|
Name |
string (100) |
Name of the product. |
|
Description |
string (100) |
The product's description field text. |
|
ProductCode |
string (100) |
A code for the product. |
|
CurrencyIsoCode |
string (100) |
Three letter currency code. |
|
DefaultPrice |
float |
The product's price. This value is optional. |
|
IsActive |
boolean |
A flag indicating the product is available. |
|
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. |
|
Type |
string (100) |
Indicate if this is a product or expense item. Values are: product or expense. |
|
IsCarAllowance |
boolean |
Flag to indicate this expense type is mileage. |
|
Uom |
string (100) |
If this is an expense type and mileage (iscarallowance), then whether the rate should be calculated as kilometer or miles. Values are KM or Mile. |
|
CategoryID |
integer |
ID of the Product Category. |
List
Description
Returns a list of products and expenses added to BlueCamroo.
URL
https://{company}.bluecamroo.com/api/product/list
HTTP Method
GET
Data Return
Returns the list of products and expenses 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 the details of the product or expense.
URL
https://{company}.bluecamroo.com/api/product/get/{id}
HTTP Method
GET
Parameters
None
Data Return
Returns the product 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 object.
URL
https://{company}.bluecamroo.com/api/product/add
HTTP Method
POST
Parameters
A product object.
Data Return
Returns the product 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 product object.
URL
https://{company}.bluecamroo.com/api/product/update
HTTP Method
PUT
Parameters
A product object.
Data Return
Returns the product 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 specified product object.
URL
https://{company}.bluecamroo.com/api/product/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)
|