Skip to main content

Estimates

Information pertaining to retrieving, creating, editing, and deleting estimates. Admin permissions required.

Link to documentation

Supported currencies

List all estimates

Returns a list of your estimates. The estimates are returned sorted by issue date, with the most recently issued estimates appearing first.

The response contains an object with a estimates property that contains an array of up to per_page estimates. Each entry in the array is a separate estimate object. If no more estimates are available, the resulting array will be empty. Several additional pagination properties are included in the response to simplify paginating your estimates.

Link to documentation

hrvst estimates list
OptionDescriptionRequired
--client_idOnly return estimates belonging to the client with the given ID.false
--updated_sinceOnly return estimates that have been updated since the given date and time.false
--fromOnly return estimates with an issue_date on or after the given date.false
--toOnly return estimates with an issue_date on or before the given date.false
--stateOnly return estimates with a state matching the value provided. Options: draft, sent, accepted, or declined.false
--pageThe page number to use in pagination. Use all to retrieve all pages.false
--per_pageThe number of records to return per page. Can range between 1 and 100.false
--fieldsComma separated list of fields to display in the output.false
--outputThe output format: json, tablefalse

Retrieve a specific estimate

Retrieves the estimate with the given ID. Returns an estimate object and a 200 OK response code if a valid identifier was provided.

Link to documentation

hrvst estimates get
OptionDescriptionRequired
--estimate_idThe ID of the estimate you're retrieving.true
--fieldsComma separated list of fields to display in the output.false
--outputThe output format: json, tablefalse

Create an estimate

Creates a new estimate object. Returns an estimate object and a 201 Created response code if the call succeeded.

Link to documentation

hrvst estimates create
OptionDescriptionRequired
--client_idThe ID of the client this estimate belongs to.true
--numberIf no value is set, the number will be automatically generated.false
--purchase_orderThe purchase order number.false
--taxThis percentage is applied to the subtotal, including line items and discounts. Example: use 10.0 for 10.0%.false
--tax2This percentage is applied to the subtotal, including line items and discounts. Example: use 10.0 for 10.0%.false
--discountThis percentage is subtracted from the subtotal. Example: use 10.0 for 10.0%.false
--subjectThe estimate subject.false
--notesAny additional notes to include on the estimate.false
--currencyThe currency used by the estimate. If not provided, the client’s currency will be used. See a list of supported currenciesfalse
--issue_dateDate the invoice was issued. Defaults to today’s date.false
--line_items[0]kindThe name of an estimate item category.false
--line_items[0]descriptionText description of the first line item.false
--line_items[0]unit_priceThe individual price per unit.false
--line_items[0]quantityThe unit quantity of the item.false
--line_items[0]taxedWhether the estimate’s tax percentage applies to this line item.false
--line_items[0]taxed2Whether the estimate’s tax2 percentage applies to this line item.false
--fieldsComma separated list of fields to display in the output.false
--outputThe output format: json, tablefalse

Update an estimate

Updates the specific estimate by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Returns an estimate object and a 200 OK response code if the call succeeded.

Link to documentation

hrvst estimates update
OptionDescriptionRequired
--estimate_idThe ID of the estimate you're updating.true
--client_idThe ID of the client this estimate belongs to.false
--numberIf no value is set, the number will be automatically generated.false
--purchase_orderThe purchase order number.false
--taxThis percentage is applied to the subtotal, including line items and discounts. Example: use 10.0 for 10.0%.false
--tax2This percentage is applied to the subtotal, including line items and discounts. Example: use 10.0 for 10.0%.false
--discountThis percentage is subtracted from the subtotal. Example: use 10.0 for 10.0%.false
--subjectThe estimate subject.false
--notesAny additional notes to include on the estimate.false
--currencyThe currency used by the estimate. If not provided, the client’s currency will be used. See a list of supported currenciesfalse
--issue_dateDate the invoice was issued. Defaults to today’s date.false
--fieldsComma separated list of fields to display in the output.false
--outputThe output format: json, tablefalse

Delete an estimate

Delete an estimate. Returns a 200 OK response code if the call succeeded.

Link to documentation

hrvst estimates delete
OptionDescriptionRequired
--estimate_idThe ID of the estimate you're deleting.true
--fieldsComma separated list of fields to display in the output.false
--outputThe output format: json, tablefalse