v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB

Quote

Retrieves the collection of Quote resources.

get/quotes

Query parameters

pageinteger

The collection page number

itemsPerPageinteger

The number of items per page

Response

Quote collection

idstring

integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

srcIdstring

Unique identifier for the item

createdstring date-time nullable

Datetime when the item was created

modifiedstring date-time nullable

Datetime when the item was last updated

customerIdstring nullable

Unique identifier for contact

customerNamestring nullable

Contact name

quoteNumberstring nullable

Generated quote number

txnDatestring nullable

Date of the quote

billingCitystring nullable

Main address city

billingPostalcodestring nullable

Main address postalcode

billingCountrystring nullable

Main address country

shippingCitystring nullable

Delivery address city

shippingCountrystring nullable

Delivery address country

totalAmountinteger nullable

Total amount of the quote

currencystring nullable

Currency of the quote

txnStatusstring nullable

Status of quote

shippingPostalcodestring nullable

Delivery address postalcode

Example response

[
  {
    "id": "quickbooks-726",
    "integration": "quickbooks",
    "srcId": "90300000072369",
    "created": "2021-07-28 00:00:00",
    "modified": "2021-09-15 00:00:00",
    "customerId": "0124",
    "customerName": "John Doe",
    "quoteNumber": "99",
    "txnDate": "2021-07-28 00:00:00",
    "billingCity": "Toronto",
    "billingPostalcode": "H6F0R3",
    "billingCountry": "Canada",
    "shippingCity": "Vancouver",
    "shippingCountry": "Canada",
    "totalAmount": 5000000,
    "currency": "CAD",
    "txnStatus": "2021-09-15 00:00:00",
    "shippingPostalcode": "V5N7G4"
  }
]