API DOCUMENTATION
    Try Unleashed Now Sandbox

    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 a page of Sales Quotes GET /SalesQuotes
    View the Sales Quote with the specified Guid 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.
    Note: Date filters should be provided in the ISO format YYYY-MM-DD.

    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 collection
    Customer Customer collection
    CustomerRef String 500
    DeliveryCity String 500
    DeliveryCountry String 500
    DeliveryMethod String 50
    DeliveryName String 500
    DeliveryPostCode String 500
    DeliveryRegion String 500
    DeliveryStreetAddress String 500
    DeliveryStreetAddress2 String 500
    DeliverySuburb String 500
    DiscountRate Decimal
    ExchangeRate Nullable Decimal
    LastModifiedBy String 256
    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 collection
    SalesQuoteLines SalesQuoteLine collection
    SourceId String 500
    SubTotal Decimal SubTotal = Sum of SalesQuoteLine Totals
    Tax Tax collection
    TaxRate Nullable Decimal
    TaxTotal Decimal TaxTotal = Sum of SalesQuoteLine Taxes
    Total Decimal Total = TaxTotal + SubTotal
    TotalVolume Nullable Decimal
    TotalWeight Nullable Decimal
    Warehouse Warehouse collection
    XeroTaxCode String 50
    Available Fields for Currency
    Property Type Length
    CurrencyCode String 3
    Description String 200
    DefaultBuyRate Decimal
    DefaultSellRate Decimal
    Guid Guid
    LastModifiedOn DateTime
    Available Fields for Customer
    Property Type Length
    CurrencyId Integer
    CustomerCode String 500
    CustomerName String 500
    Guid Guid
    LastModifiedOn DateTime
    Available Fields for Sales Orders
    Property Type Length
    Guid Guid
    OrderNumber String 20
    Available Fields for Salesperson
    Property Type Length
    Email String 500
    FullName String 500
    Guid Guid
    Obsolete Boolean
    LastModifiedOn DateTime
    Available Fields for Tax
    Property Type Length
    CanApplyToExpenses Boolean
    CanApplyToRevenue Boolean
    Description String 50
    Guid Guid
    LastModifiedOn DateTime
    Obsolete Boolean
    TaxCode String 25
    TaxRate Decimal
    Available Fields for Warehouse
    Property Type Length
    AddressLine1 String 500
    AddressLine2 String 500
    City String 500
    ContactName String 50
    Country String 500
    DDINumber String 25
    FaxNumber String 25
    Guid Guid
    IsDefault Boolean
    LastModifiedOn DateTime
    MobileNumber String 25
    Obsolete Boolean
    PostCode String 500
    PhoneNumber String 25
    Region String 500
    StreetNo String 500
    Suburb String 500
    WarehouseCode String 15
    WarehouseName String 100
    Available Fields for Sales Quote Lines
    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
    Product Product collection
    QuoteQuantity Decimal
    TaxRate Nullable Decimal
    UnitCost Nullable Decimal Follows hierarchy:
    1. Nominal Cost
    2. Average Land Cost
    3. Last Cost
    UnitPrice Decimal
    Volume Nullable Decimal
    Weight Nullable Decimal
    XeroSalesAccount String 50
    XeroTaxCode String 50
    Available Fields for Product
    Property Type Length
    Guid Guid
    ProductCode String 100
    ProductDescription String 500

    Examples for Response GET /SalesQuotes

    show xml example
    show json example

    Use the API Sandbox to see how the object is rendered in JSON or XML.

    Note: An Unleashed account is required before you can use the API Sandbox.

    Trial accounts are also allowed to connect to the API.
    You can register a new account here: Register.