v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB

Estimate

Retrieves the collection of Estimate resources.

get/estimates

Query parameters

pageinteger

The collection page number

itemsPerPageinteger

The number of items per page

Response

Estimate collection

idstring

integrationstring

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

estimateNumberstring nullable

For searching estimates

txnStatusstring nullable

Transaction status e.g. Accepted

billingEmailstring nullable

Billing email

txnDatestring date-time nullable

Transaction date

totalAmountinteger

Estimate total amount

customerNamestring

Customer full name

customerIdstring

Customer Id

customerMemostring nullable

Customer memo

shippingLine1string nullable

Shipping address line 1

shippingLine2string nullable

Shipping address line 2

shippingCitystring nullable

Shipping address city

shippingCountrystring nullable

Shipping address country

shippingPostalcodestring nullable

Shipping address postal code

billingLine1string nullable

Billing address line 1

billingLine2string nullable

Billing address line 2

billingCitystring nullable

Billing address city

billingCountrystring nullable

Billing address country

billingPostalcodestring nullable

Billing address postal code

totalTaxinteger nullable

Total tax applied

createdstring date-time nullable

Date entry was created

modifiedstring date-time nullable

Date entry was modified

referenceNumberstring nullable

Estimate reference number

currencystring nullable

Currency code

discountAmountinteger nullable

Discount amount

billingStatestring nullable

Billing address state/province

shippingStatestring nullable

State assocaited with the shipping address

Example response

[
  {
    "integration": "quickbooks"
  }
]