Get Estimates List

Overview

Returns a list of estimates for the business.

Authentication

Available for Staff tokens only. Requires payments.manage permission.

Fallback API Required - This endpoint must be accessed via the fallback API URL.

Filtering

Use the filter parameter to filter results:

  • filter[created_at][gt]=2019-01-01 - Estimates created after date
  • filter[updated_at][lt]=2019-12-31 - Estimates updated before date
  • filter[state][in]=issued,rejected - Estimates with specific states

Available filter operators for dates: gt, gte, lt, lte, eq Available filter operators for state: in

Sorting

Use the sort parameter to sort results:

  • sort=created_at:asc - Sort by created_at ascending
  • sort=updated_at:desc - Sort by updated_at descending
  • sort=created_at:asc,updated_at:desc - Multiple sort fields
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Filter results. Available fields: created_at, updated_at, state. State values: issued, approved, draft, invoiced, rejected. Operators for dates: gt, gte, lt, lte, eq. Operators for state: in. Example: filter[state][in]=issued,rejected

string

Sort results. Available fields: created_at, updated_at, state. Operators: asc, desc. Example: sort=created_at:asc,updated_at:desc

integer

Page number of results. Default: 1

integer

How many items to return per page. Default: 25

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json