Estimates (or quotes) are proposals for products or services that you can send to your clients.
Get an estimate by estimate_id
Returns all information about an estimate with the given estimate id
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
estimate_idUnique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Get an estimate by estimate_id › Responses
An estimate
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
contact_id^\d+$A unique record identifier
contact_person_id^\d+$A unique record identifier
estimate_idestimate_sequence_idworkflow_id^\d+$A unique record identifier
document_style_id^\d+$A unique record identifier
identity_id^\d+$A unique record identifier
draft_idstateestimate_datedue_datereferencelanguagecurrencyoriginal_estimate_id^\d+$A unique record identifier
show_taxsign_onlinesent_ataccepted_atrejected_atarchived_atcreated_atupdated_atpublic_view_code^\d+$public_view_code_expires_atversionpre_textpost_textprices_are_incl_taxurlList all ids and versions
Returns all estimates in the administration. The list contains the id and version of the estimate.
If the version of the estimate is newer than the version you have stored locally, use the POST
variant to fetch estimates with the given ids.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
query Parameters
filterList all ids and versions › Responses
IDs and versions of records
idversionFetch estimates with given ids
Given a list of estimate ids, returns the estimate information belonging to the estimates. Returns a maximum of 100 estimates, even if more ids are provided.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Fetch estimates with given ids › Responses
A list of estimates
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
contact_id^\d+$A unique record identifier
contact_person_id^\d+$A unique record identifier
estimate_idestimate_sequence_idworkflow_id^\d+$A unique record identifier
document_style_id^\d+$A unique record identifier
identity_id^\d+$A unique record identifier
draft_idstateestimate_datedue_datereferencelanguagecurrencyoriginal_estimate_id^\d+$A unique record identifier
show_taxsign_onlinesent_ataccepted_atrejected_atarchived_atcreated_atupdated_atpublic_view_code^\d+$public_view_code_expires_atversionpre_textpost_textprices_are_incl_taxurlDownload attachment
Download the attachment. The response will be a redirect to a temporarily available URL
where the attachment can be downloaded. Use the Location header in the response
to download the attachment.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
estimate_id^\d+$ · requiredA unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Download attachment › Responses
Found
Delete an attachment
Deletes an attachment of an attachable.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
estimate_id^\d+$ · requiredA unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Delete an attachment › Responses
Attachment deleted
Destroys note from entity
Deletes a note from the estimate.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
estimate_id^\d+$ · requiredA unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Destroys note from entity › Responses
Note deleted
Adds note to entity
Adds a note to the estimate.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
estimate_id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Adds note to entity › Responses
Note created
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
entity_id^\d+$A unique record identifier
entity_typeuser_id^\d+$A unique record identifier
assignee_id^\d+$A unique record identifier
todonotecompleted_atcompleted_by_id^\d+$A unique record identifier
todo_typedatacreated_atupdated_atAdd attachment to estimate
Add an attachment to an estimate.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Add attachment to estimate › Responses
Status code
Bills an estimate
An invoice is created based on the accepted estimate.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Bills an estimate › Responses
Estimate billed
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
contact_id^\d+$A unique record identifier
contact_person_id^\d+$A unique record identifier
invoice_idrecurring_sales_invoice_id^\d+$A unique record identifier
subscription_id^\d+$A unique record identifier
workflow_id^\d+$A unique record identifier
document_style_id^\d+$A unique record identifier
identity_id^\d+$A unique record identifier
draft_idstateinvoice_datedue_datepayment_conditionspayment_referenceshort_payment_referencereferencelanguagecurrencydiscountoriginal_sales_invoice_id^\d+$A unique record identifier
pausedpaid_atsent_atcreated_atupdated_atpublic_view_codepublic_view_code_expires_atversiontotal_paidtotal_unpaidtotal_unpaid_baseprices_are_incl_taxtotal_price_excl_taxtotal_price_excl_tax_basetotal_price_incl_taxtotal_price_incl_tax_basetotal_discountmarked_dubious_onmarked_uncollectible_onreminder_countnext_reminderoriginal_estimate_id^\d+$A unique record identifier
urlpayment_urlChanges the state of an estimate
Not every state change is allowed. e.g. open to billed is accepted, draft to open is not. Note: this only changes the state and does not perform other actions like sending or billing the estimate.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Changes the state of an estimate › Request Body
stateCan be accepted, rejected, open, late, billed or archived.
Changes the state of an estimate › Responses
Estimate updated
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
contact_id^\d+$A unique record identifier
contact_person_id^\d+$A unique record identifier
estimate_idestimate_sequence_idworkflow_id^\d+$A unique record identifier
document_style_id^\d+$A unique record identifier
identity_id^\d+$A unique record identifier
draft_idstateestimate_datedue_datereferencelanguagecurrencyoriginal_estimate_id^\d+$A unique record identifier
show_taxsign_onlinesent_ataccepted_atrejected_atarchived_atcreated_atupdated_atpublic_view_code^\d+$public_view_code_expires_atversionpre_textpost_textprices_are_incl_taxurlDownload estimate PDF by id
Redirects to the download URL of the estimate as PDF. The link is valid for 30 seconds.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
query Parameters
mediaIn case you want to hide sender address and logo you can set this to 'stationery'.
Download estimate PDF by id › Responses
Found
Sends an estimate
You can provide a send method, email address and message. If you don't provide any arguments, the defaults from the contact and workflow will be used.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Sends an estimate › Request Body
sendersignature_outputaudit_trailip_addressSends an estimate › Responses
Estimate updated
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
contact_id^\d+$A unique record identifier
contact_person_id^\d+$A unique record identifier
estimate_idestimate_sequence_idworkflow_id^\d+$A unique record identifier
document_style_id^\d+$A unique record identifier
identity_id^\d+$A unique record identifier
draft_idstateestimate_datedue_datereferencelanguagecurrencyoriginal_estimate_id^\d+$A unique record identifier
show_taxsign_onlinesent_ataccepted_atrejected_atarchived_atcreated_atupdated_atpublic_view_code^\d+$public_view_code_expires_atversionpre_textpost_textprices_are_incl_taxurlGet an estimate by id
Returns all information about an estimate.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
query Parameters
includesGet an estimate by id › Responses
A estimate
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
contact_id^\d+$A unique record identifier
contact_person_id^\d+$A unique record identifier
estimate_idestimate_sequence_idworkflow_id^\d+$A unique record identifier
document_style_id^\d+$A unique record identifier
identity_id^\d+$A unique record identifier
draft_idstateestimate_datedue_datereferencelanguagecurrencyoriginal_estimate_id^\d+$A unique record identifier
show_taxsign_onlinesent_ataccepted_atrejected_atarchived_atcreated_atupdated_atpublic_view_code^\d+$public_view_code_expires_atversionpre_textpost_textprices_are_incl_taxurlDeletes an estimate
Deletes an estimate.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Deletes an estimate › Responses
Estimate deleted
Updates an estimate
When updating an estimate, provide only the attributes you want to update. The other attributes will not be changed.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Updates an estimate › Responses
Estimate updated
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
contact_id^\d+$A unique record identifier
contact_person_id^\d+$A unique record identifier
estimate_idestimate_sequence_idworkflow_id^\d+$A unique record identifier
document_style_id^\d+$A unique record identifier
identity_id^\d+$A unique record identifier
draft_idstateestimate_datedue_datereferencelanguagecurrencyoriginal_estimate_id^\d+$A unique record identifier
show_taxsign_onlinesent_ataccepted_atrejected_atarchived_atcreated_atupdated_atpublic_view_code^\d+$public_view_code_expires_atversionpre_textpost_textprices_are_incl_taxurlList all estimates
Returns a paginated list of all estimates in the administration.
The filter argument allows you to filter on the list of estimates. Filters are a combination of keys and values,
separated by a comma: period:this_year,state:all. The available options for filtering are:
| Filter | Type | Default | Description |
|---|---|---|---|
| state | String | all | all, draft, open, late, accepted, rejected, billed or archived |
| period | String | this_year | This can either be the description of a period (this_month, prev_month, next_month, this_quarter, prev_quarter, next_quarter, this_year, prev_year, next_year) or a custom period (201301..201302, 20130101..20130131) |
| contact_id | Integer | Filters estimates by a single contact | |
| workflow_id | Integer | Filters estimates by a single workflow |
You can filter by multiple states at the same time as well. To do this, separate the state values by a pipe: state:draft|scheduled.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
query Parameters
filterSee table above for detailed options.
pageper_page^\d+$List all estimates › Responses
A list of estimates
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
contact_id^\d+$A unique record identifier
contact_person_id^\d+$A unique record identifier
estimate_idestimate_sequence_idworkflow_id^\d+$A unique record identifier
document_style_id^\d+$A unique record identifier
identity_id^\d+$A unique record identifier
draft_idstateestimate_datedue_datereferencelanguagecurrencyoriginal_estimate_id^\d+$A unique record identifier
show_taxsign_onlinesent_ataccepted_atrejected_atarchived_atcreated_atupdated_atpublic_view_code^\d+$public_view_code_expires_atversionpre_textpost_textprices_are_incl_taxurlCreates a new estimate
Creates a new estimate.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Creates a new estimate › Responses
Estimate created
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
contact_id^\d+$A unique record identifier
contact_person_id^\d+$A unique record identifier
estimate_idestimate_sequence_idworkflow_id^\d+$A unique record identifier
document_style_id^\d+$A unique record identifier
identity_id^\d+$A unique record identifier
draft_idstateestimate_datedue_datereferencelanguagecurrencyoriginal_estimate_id^\d+$A unique record identifier
show_taxsign_onlinesent_ataccepted_atrejected_atarchived_atcreated_atupdated_atpublic_view_code^\d+$public_view_code_expires_atversionpre_textpost_textprices_are_incl_taxurl