Sales Quotes
The SalesQuotes resource allows sales quotes to be listed and viewed. An individual sales quote details can be viewed by appending its identifier (a GUID formatted as XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
) to the URI.
The full range of URIs and HTTP Verbs supported are:
Operation | HTTP Action |
---|---|
List of paginated Sales Quotes | GET /SalesQuotes/Page/{pageNumber} |
View any Sales Quote | GET /SalesQuotes/{quoteGuid} |
GET Sales Quotes
Available Filters for GET Sales Quotes
Filter | Description |
---|---|
customerCode |
Returns Quotes that start with the specific customer code. |
endDate |
Returns Quotes created before a specified date, must be UTC format. |
modifiedSince |
Returns Quotes created or edited after a specified date, must be UTC format. |
pageSize |
Specifies the page size for pagination. Default page size is 200 quotes.
Note: Requesting large numbers of quotes can be susceptible to poor network performance. Please reduce the page size if you experience delayed requests. |
quoteNumber |
Returns a single Quote with the specified quote number. If set, it overrides all other filters. |
quoteStatus |
Returns Quotes with the specified status. Multiple selection can be specified as comma separated.For example: `quoteStatus=Completed,Parked`. If no quoteStatus filter is specified, then we exclude "Deleted" by default. |
sourceId |
Returns Quotes with the specified sourceId. If set, it overrides all other filters. |
startDate |
Returns Quotes created after a specified date, must be UTC format. |
Filters are used by adding the filter and value to the URI:
/SalesQuotes?customerCode=ACME&startDate=2012-01-01
Tip: To efficiently retrieve a count of the Quotes that match a filter, specify a pageSize of 0: /SalesQuotes?quoteStatus=Parked,Placed&pageSize=0
. The default ordering is by LastModifiedOn descending.
Available Fields for GET Sales Quotes
Property | Type | Length | Notes |
---|---|---|---|
AcceptedDate | Nullable DateTime | UTC timezone only | |
BCSubTotal | Nullable Decimal | Base Currency SubTotal | |
BCTaxTotal | Nullable Decimal | Base Currency TaxTotal | |
BCTotal | Nullable Decimal | Base Currency Total | |
Comments | String | 2048 | |
CreatedBy | String | 50 | |
CreatedOn | DateTime | ||
Currency | Currency | ||
Customer | Customer | ||
CustomerRef | String | 500 | |
DeliveryCity | String | 50 | |
DeliveryCountry | String | 50 | |
DeliveryMethod | String | 50 | |
DeliveryName | String | 50 | |
DeliveryPostCode | String | 50 | |
DeliveryRegion | String | 50 | |
DeliveryStreetAddress | String | 200 | |
DeliveryStreetAddress2 | String | 200 | |
DeliverySuburb | String | 50 | |
DiscountRate | Decimal | ||
ExchangeRate | Nullable Decimal | ||
LastModifiedBy | String | 50 | |
LastModifiedOn | Nullable DateTime | ||
QuoteDate | Nullable DateTime | ||
QuoteExpiryDate | Nullable DateTime | ||
QuoteNumber | String | 17 | |
QuoteStatus | String | 20 | |
SalesOrderGroup | String | 50 | |
SalesOrders | SalesOrder collection | A list of sales orders that are linked to the sales quote. The Guid and OrderNumber for every SalesOrder linked to the SalesQuote will be returned in the list/collection. | |
SalesPerson | SalesPerson | ||
SalesQuoteLines | SalesQuoteLine collection | ||
SourceId | String | 500 | |
SubTotal | Decimal | SubTotal = Sum of SalesQuoteLine Totals | |
Tax | Tax | ||
TaxRate | Nullable Decimal | ||
TaxTotal | Decimal | TaxTotal = Sum of SalesQuoteLine Taxes | |
Total | Decimal | Total = TaxTotal + SubTotal | |
TotalVolume | Nullable Decimal | ||
TotalWeight | Nullable Decimal | ||
Warehouse | Warehouse | ||
XeroTaxCode | String | 50 |
Available Fields for SalesQuoteLine
Property | Type | Length | Notes |
---|---|---|---|
BCLineTax | Decimal | Base Currency LineTax | |
BCLineTotal | Decimal | Base Currency LineTotal | |
BCUnitPrice | Decimal | Base Currency UnitPrice | |
Comments | String | 1024 | |
DiscountRate | Decimal | ||
LineNumber | Integer | ||
LineTax | Decimal | ||
LineTaxCode | String | 50 | |
LineTotal | Decimal | ||
LineType | String | ||
QuoteQuantity | Decimal | ||
TaxRate | Nullable Decimal | ||
UnitCost | Nullable Decimal | Follows hierarchy: 1. Nominal Cost 2. Average Land Cost 3. Last Cost |
|
UnitPrice | Decimal | ||
Weight | Nullable Decimal | ||
XeroSalesAccount | String | 50 | |
XeroTaxCode | String | 50 | |
Volume | Nullable Decimal |