|
SaleQuote
An object representing a sales quote.
Supported API Calls: Get | Add | Update | Delete
Object Properties
class="tabletxt">Description|
Property |
Type |
Description |
|
Id |
integer |
A unique ID for the sales quote. When adding a new sales quote the value must be 0. |
|
ParentId |
integer |
ID of the parent opportunity or project. |
|
ParentObject |
string (100) |
ParentObject identifies what kind of object the sales quote is a child of. Value is project or opportunity. |
|
QuoteNumber |
string (100) |
The sales quote's number. |
|
QuoteDate |
DateTime |
Date the quote was created |
|
Description |
string (100) |
Comment text. |
|
SubTotal |
float |
Quote total before taxes. |
|
TaxTotal |
float |
Total of the quotes taxes. |
|
QuoteTotal |
float |
The quote's total. |
|
CurrencyIsoCode |
string (100) |
Currency symbol used for the value on display. |
|
ValidDate |
DateTime |
Last day the quote is valid for. |
|
QuoteSendDate |
DateTime |
Date the quote was sent. |
|
IsLocked |
boolean |
Flag indicating the quote can't be edited. This property is read only |
|
IsAccepted |
boolean |
Flag the quote has been accepted. |
|
AcceptedDate |
DateTime |
Date the quote was accepted. |
|
AcceptedIpAddress |
string (100) |
IP address of the acceptor. |
|
AcceptedReason |
string (100) |
Any text the acceptor included in the acceptance. |
|
OwnerId |
integer |
ID of the internal user who owns this quote. |
|
Status |
string (100) |
ID matching the Sales Quote Status lookup value. |
|
AttachmentList |
List<AttachmentAssociate> |
A list of any attachment objects. |
Get
Description
Returns the details of a specified SaleQuote.
URL
https://{company}.bluecamroo.com/api/SaleQuote/{id}
HTTP Method
GET
Parameters
None
Data Return
Returns an SaleQuote 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 an SaleQuote object.
URL
https://{company}.bluecamroo.com/api/SaleQuote/add
HTTP Method
POST
Parameters
An SaleQuote object
Data Return
Returns the SaleQuote 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 the specified SaleQuote.
URL
https://{company}.bluecamroo.com/api/SaleQuote/update
HTTP Method
PUT
Parameters
An SaleQuote object
Data Return
Returns the SaleQuote 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 SaleQuote.
URL
https://{company}.bluecamroo.com/api/SaleQuote/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)
|