GET All Estimates - Daftra API Docs

Retrieves a paginated list of all estimates/quotes. The response includes both estimate data and pagination information.

Parameters:

limit: Number of records per page (1-1000)

page: Page number for pagination

search: Optional search term to filter results

start_date: Optional filter by estimate date (YYYY-MM-DD)

end_date: Optional filter by estimate date (YYYY-MM-DD)

client_id: Optional filter by client ID

status: Optional filter by status (0: draft, 1: sent, 2: accepted, 3: declined)

sort: Optional field to sort by (id, date, total, etc.)

direction: Optional sort direction (asc or desc)

Response:

{
  "result": "success",
  "code": 200,
  "data": [
    {
      "Estimate": {
        "id": 234,
        "number": "EST-2023-001",
        "client_id": 15,
        "date": "2023-03-20",
        "expiry_date": "2023-04-19",
        "total": 350.00,
        "status": 1,
        "currency_code": "USD",
        // Additional estimate fields...
      },
      "Client": {
        "id": 15,
        "name": "ACME Corp",
        // Additional client fields...
      },
      "InvoiceItem": [
        {
          "id": 567,
          "estimate_id": 234,
          "product_id": 1,
          "description": "Premium Widget",
          "quantity": 3,
          "unit_price": 100.00,
          "discount": 0,
          "tax1": 50.00,
          "total": 350.00
          // Additional item fields...
        }
      ]
    }
    // Additional estimates...
  ],
  "pagination": {
    "page": 1,
    "page_count": 3,
    "total_results": 45,
    "prev": null,
    "next": "/api2/estimates.json?page=2"
  }
}

{ "result": "success", "code": 200, "data": [ { "Estimate": { "id": 234, "number": "EST-2023-001", "client_id": 15, "date": "2023-03-20", "expiry_date": "2023-04-19", "total": 350, "status": 1, "currency_code": "USD", "draft": 0, "notes": "Proposal for Q2 services", "created": "2023-03-20 10:15:22", "modified": "2023-03-20 10:15:22" }, "Client": { "id": 15, "name": "ACME Corp", "business_name": "ACME Corporation", "email": "billing@acmecorp.com" }, "InvoiceItem": [ { "id": 567, "estimate_id": 234, "product_id": 1, "description": "Premium Widget", "quantity": 3, "unit_price": 100, "discount": 0, "tax1": 50, "total": 350 } ] }, { "Estimate": { "id": 233, "number": "EST-2023-002", "client_id": 16, "date": "2023-03-18", "expiry_date": "2023-04-17", "total": 750, "status": 1, "currency_code": "USD", "draft": 0, "notes": "Website development proposal", "created": "2023-03-18 14:30:45", "modified": "2023-03-18 14:30:45" }, "Client": { "id": 16, "name": "Global Industries", "business_name": "Global Industries Ltd.", "email": "ap@globalindustries.com" }, "InvoiceItem": [ { "id": 566, "estimate_id": 233, "product_id": 5, "description": "Website Design & Development", "quantity": 1, "unit_price": 750, "discount": 0, "tax1": 0, "total": 750 } ] } ], "pagination": { "page": 1, "page_count": 3, "total_results": 45, "prev": null, "next": "/api2/estimates.json?page=2" } }

Request

Query Params

limit

string

required

Number of records to return per page (1-1000)

Example:

page

string

required

Page number for pagination

Example:

string

required

Search term to filter results

start_date

string

required

Filter by start date (YYYY-MM-DD)

end_date

string

required

Filter by end date (YYYY-MM-DD)

client_id

string

required

Filter by client ID

status

string

required

Filter by status (0: draft, 1: sent, 2: accepted, 3: declined)

sort

string

required

Field to sort by (id, date, total, etc.)

Example:

direction

string

required

Sort direction (asc or desc)

Example:

desc

Responses

🟢200Success Response

application/json

Body

result

string

required

code

integer

required

data

array [object {3}]

required

Estimate

object

required

Client

object

required

InvoiceItem

array [object {9}]

required

pagination

object

required

page

integer

required

page_count

integer

required

total_results

integer

required

null

required

string

required