Skip to main content

Estimate Messages

Information pertaining to retrieving, creating, and deleting estimate messages, as well as accepting, declining, and re-opening estimates. Admin permissions required.

Link to documentation

List all messages for an estimate

Returns a list of messages associated with a given estimate. The estimate messages are returned sorted by creation date, with the most recently created messages appearing first.

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

Link to Documentation

hrvst estimates messages list-by-estimate
OptionDescriptionRequired
--estimate_idThe ID of the estimate that contains the messages you're retrieving.true
--updated_sinceOnly return estimate messages that have been updated since the given date and time.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 2000.false
--fieldsComma separated list of fields to display in the output.false
--outputThe output format: json, tablefalse

Create an estimate message

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

Link to Documentation

hrvst estimates messages create
OptionDescriptionRequired
--estimate_idThe ID of the invoice that you're creating the message for.true
--recipients[0]emailEmail of the message recipient.true
--recipients[0]nameName of the message recipient.true
--subjectThe message subject.false
--bodyThe message body.false
--send_me_a_copyWhether to email a copy of the message to the current user.false
--event_typeIf provided, runs an event against the estimate. Options: “accept”, “decline”, “re-open”, or “send”.false
--fieldsComma separated list of fields to display in the output.false
--outputThe output format: json, tablefalse

Delete an estimate message

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

Link to Documentation

hrvst estimates messages delete
OptionDescriptionRequired
--estimate_idThe ID of the invoice that contains the message you are deleting.true
--message_idThe ID of the message you are deleting.true
--fieldsComma separated list of fields to display in the output.false
--outputThe output format: json, tablefalse

Mark a draft estimate as sent

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

Link to Documentation

hrvst estimates messages mark-draft-estimate-as-sent
OptionDescriptionRequired
--estimates_idThe ID of the estimate you're marking as sent.true
--event_typePass “send” to mark the estimate as sent.true
--fieldsComma separated list of fields to display in the output.false
--outputThe output format: json, tablefalse

Re-open a closed estimate

Creates a new estimate message object and re-opens a closed estimate. Returns an estimate message object and a 201 Created response code if the call succeeded.

Link to Documentation

hrvst estimates messages re-open-closed-estimate
OptionDescriptionRequired
--estimate_idThe ID of the estimate you're re-opening.true
--event_typePass "re-open" to re-open the estimatetrue
--fieldsComma separated list of fields to display in the output.false
--outputThe output format: json, tablefalse