List estimates
sales:estimates.readhttps://api.holded.com/api/v2/estimatesReturns a paginated list of estimates in your account. Results are cursor-paginated: the response includes a `cursor` value and a `has_more` boolean. Pass the `cursor` to the next request to fetch the following page. A signed-in user with limited access to estimates gets only the estimates assigned to them. API keys still need the scope of this endpoint.
Parameters
Query parameters
integeroptional= 50Maximum number of estimates to return per page. Defaults to 50, maximum 200.
stringoptionalPagination cursor returned by the previous response. Omit to start from the first page.
stringoptionalFilter estimates by contact identifier
stringoptionalFilter estimates by the customer's decision on the quote: "completed" is shown as **Accepted** in the app, "failed" as **Rejected**, "pending" as awaiting an answer. Independent of `billing_status`.
"pending""completed""partial""cancelled""failed""overdue"stringoptionalFilter estimates by their invoicing status (the **Billed** column in Sales > Quotes). Independent of `status`.
"pending""paid""partial"string<date-time>optionalFilter from this date. Accepts ISO 8601 datetime or date only (YYYY-MM-DD)
string<date-time>optionalFilter up to this date. Accepts ISO 8601 datetime or date only (YYYY-MM-DD). A date without a time (YYYY-MM-DD) includes that whole day; a value with a time is applied exactly as sent.
stringoptionalSort order for results. Prefix with - for descending.
"date""-date""dueDate""-dueDate""total""-total"stringoptionalFilter by approval status. Use "draft" for unapproved estimates, "approved" for approved ones.
"draft""approved"Request
import requests
url = "https://api.holded.com/api/v2/estimates?limit=50&cursor=value&contact_id=value"
headers = {
"Authorization": "Bearer YOUR_API_KEY",
"Accept": "application/json",
}
response = requests.get(url, headers=headers)
print(response.json())Responses
Response
{
"items": [
{
"id": "507f1f77bcf86cd799439011",
"document_number": "INV-0001",
"contact_id": "507f1f77bcf86cd799439011",
"contact_name": "Acme Corp",
"description": "string",
"date": "2024-01-15",
"due_date": "2024-02-15",
"subtotal": "100.00",
"discount": "0",
"total": "121.00",
"tax": "21.00",
"currency": "EUR",
"status": "pending",
"tags": [
"string"
],
"lines": [
{
"line_id": "...",
"name": "...",
"description": "...",
"price": "...",
"units": "...",
"discount": "...",
"tax": "...",
"taxes": "...",
"tags": "...",
"product_id": "...",
"variant_id": "...",
"service_id": "...",
"sku": "...",
"weight": "...",
"cost_price": "...",
"account": "...",
"project_id": "...",
"retention": "...",
"unit_type": "...",
"supplied": "..."
}
]
}
],
"has_more": false,
"cursor": "string"
}Success responses
200List of estimatesapplication/jsonUnique identifier of the document
Sequential number assigned to the document
Identifier of the contact associated with this document
Name of the contact associated with this document
Free-text description of the document
Issue date of the document in ISO 8601 format
Payment due date in ISO 8601 format
Sum of all line amounts before tax and discounts, as a decimal string
Total discount applied to the document, as a decimal string
Final amount including taxes and discounts, as a decimal string
Total tax amount, as a decimal string
ISO 4217 currency code
Current status of the document
failedcompletedpendingpartialcancelledList of tags attached to the document
Line items included in the document
Opaque cursor to pass as ?cursor= to fetch the next page. Null on the last page.
Error responses
401Invalid or missing API keyapplication/json403Insufficient permissionsapplication/json429Rate limit exceededapplication/json