Resource URL

Returns a specific quote object.

GET /quotes/:id

Parameters

Table of allowed parameters.

_fields	partial string	Allows you to specify optional fields and linked objects to include in the response.

Handling the response

Below is a table of available response fields and objects that are returned within the response object of the returned object. The optional fields and objects can be requested in the _fields parameter; see included examples. Underlined values are default.

id	unsigned int	A unique id assigned to the quote.
title	string	The title assigned to the quote.
standing	string	The raw standing of the quote. e.g, "draft", "published", "accepted", "declined", "converted" or "inactive"
manager	unsigned int	The staff id of the quote's manager.
manager()	object	The staff object of the quote's manager.
affiliation_id	unsigned int	The quote's affiliation id.
contact()	object	The quote's affiliation and contact object.
status	unsigned int	An id of the quote's status object.
status()	object	The quote's status object. This optional object supports, id, title, color, standing and ordering.
date_created	unix timestamp	The date the quote was created.
date_expiry	unix_timestamp	The date (if applicable) of when the quote is set to expire.
notes	string	-
introduction	HTML string	-
terms	HTML string	-
conclusion	HTML string	-
portal_access	enum(yes,no)	-
service_price_total	decimal	-
service_time_total	unsigned int	-
material_price_total	decimal	-
total_price	decimal	-

Fields that can be object indicate the field can be requested as a resource. For example.

GET /quotes/1?_fields=manager

would return the manager's staff id. Where as,

GET /quotes/1?_fields=manager(email)

would return the manager's staff object, including any optional fields or objects within the parenthesis. In the above examples case, it would return the managers objects default values and optional email value.