xmlapi/quotes.xml
jsonapi/quotes.json
Parameter | Type | Description |
---|---|---|
[IN] Parameters described in Overview | ||
Company | String | [IN] The company number(s) |
Job-And-Phase | String | [IN] Phase to retrieve quote lines for |
Job-Number | String | [IN] Job/Opp to retrieve quote lines for |
Response | XML or JSON | [OUT] XML or JSON containing quote lines for the job or phase supplied |
Description
The Quotes call retrieves a list of quote lines for a specified job/opp or phase. The list returned is correctly ordered.
Parameters
- Company – The company number(s) which contain the list required. If passing multiple company numbers, they should be delimited with a carriage return.
- Job-And-Phase – The fully qualified job-and-phase number
- Job-Number – The job number to return all quote lines for a job/opp
Note
Only pass EITHER Job-And-Phase OR Job-Number
Return Values
Response – XML or JSON containing the list of quote lines in the correct order.
<Quotes TotalRows=nnn TotalPages=nnn MorePages=True/False>
<Quote uuid={UUID of record}>
<Job-and-Phase> Job and phase number of quote line (eg: 1/00009882.001)
The Synergist UI displays only the phase number (eg: 001) when showing quote lines for a job/opp as a whole and does not display this field when showing quote lines for a single phase.
This element may be omitted when retrieving quote lines for a job rather than a single phase, depending on settings in Synergist.
<Line-Number> Quote line number
<Line-Desc> Quote line description/heading
<Line-Detail> Quote line text detail (may contain paragraphs of text)
<Line-Qty> Quote line quantity
<Line-Unit-Price> Quote line unit price
<Line-Value> Quote line total value
<Line_Bold> Quote line is Bold (True/False)
<Line_Italic> Quote line is Italic (True/False)
<Line_Underline> Quote line is Underlined (True/False)
<BreakCode> Quote line special break code for page breaking output
<BreakLine> Quote line is a break line (True/False)