Allows you to retrieve any sales quotes
GET {{baseUrl}}/Quotes?DateFrom=<date>&DateTo=<date>&ExpiryDateFrom=<date>&ExpiryDateTo=<date>&ContactID=<uuid>&Status=<string>&page=<integer>&order=<string>&QuoteNumber=<string>
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
DateFrom | string | Filter for quotes after a particular date | |
DateTo | string | Filter for quotes before a particular date | |
ExpiryDateFrom | string | Filter for quotes expiring after a particular date | |
ExpiryDateTo | string | Filter for quotes before a particular date | |
ContactID | string | Filter for quotes belonging to a particular contact | |
Status | string | Filter for quotes of a particular Status | |
page | string | e.g. page=1 – Up to 100 Quotes will be returned in a single API call with line items shown for each quote | |
order | string | Order by an any element | |
QuoteNumber | string | Filter by quote number (e.g. GET https://.../Quotes?QuoteNumber=QU-0001) |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
If-Modified-Since | string | Only records created or modified since this timestamp will be returned | |
xero-tenant-id | string | (Required) Xero identifier for Tenant |
RESPONSES
status: OK
{"Id":"bb583e7e-9b6b-471e-88da-4cbfcfad7a57","Status":"OK","ProviderName":"Adams OAuth2 App","DateTimeUTC":"/Date(1571876635477)/","Quotes":[{"QuoteID":"be59294f-2a9c-4cee-8c64-0f0ddbc1883a","QuoteNumber":"QU-0001","Reference":"REF-123","Terms":"Not valid after the expiry date","Contact":{"ContactID":"060816db-0ed7-44de-ab58-8fee9316fcd5","Name":"Adam"},"LineItems":[{"LineItemID":"ccf5e45c-73b6-4659-83e8-520f4c6126fd","AccountCode":"200","Description":"Fish out of Water","UnitAmount":19.95,"DiscountRate":10.0,"LineAmount":17.96,"ItemCode":"BOOK","Quantity":1.0,"TaxAmount":2.69,"TaxType":"OUTPUT2","Tracking":[{"TrackingCategoryID":"351953c4-8127-4009-88c3-f9cd8c9cbe9f","TrackingOptionID":"ce205173-7387-4651-9726-2cf4c5405ba2","Name":"Region","Option":"Eastside"}]}],"Date":"/Date(1571875200000)/","DateString":"2019-10-24T00:00:00","ExpiryDate":"/Date(1571961600000)/","ExpiryDateString":"2019-10-25T00:00:00","Status":"ACCEPTED","CurrencyRate":0.937053,"CurrencyCode":"AUD","SubTotal":17.96,"TotalTax":2.69,"Total":20.65,"TotalDiscount":1.99,"Title":"Your Quote","Summary":"Please buy this","BrandingThemeID":"4c82c365-35cb-467f-bb11-dce1f2f2f67c","UpdatedDateUTC":"/Date(1571869373890)/","LineAmountTypes":"EXCLUSIVE"}]}