Skip to main content
GET
Get aggregate estimates for a period

Authorizations

x-api-key
string
header
default:<your-api-key>
required
organisation
string
header
default:<your-organisation-id>
required

Query Parameters

aggregate_id
string<uuid>
required
customer_id
string<uuid>
required
start_date
string<date>
required
end_date
string<date>
required
get_single
boolean
default:true

Response

Successful Response

id
string<uuid>
required

UUID of the estimate

organisation_id
string<uuid>
required

UUID of the organisation

aggregate_id
string<uuid>
required

UUID of the aggregate

customer_id
string<uuid>
required

UUID of the customer

start_date
string<date>
required

Start date of the estimate

end_date
string<date>
required

End date of the estimate

value
EstimateValue · object
required

Value of the estimate

created_at
string<date-time>
required

Creation timestamp of the estimate

updated_at
string<date-time> | null

Deletion timestamp of the estimate

deleted_at
string<date-time> | null

Deletion timestamp of the estimate