Skip to main content

Estimate Item Categories

Information pertaining to retrieving, creating, editing, and deleting invoice item categories. Admin or project manager permissions required.

Link to documentation

List all estimate item categories

Returns a list of your estimate item categories. The estimate item categories are returned sorted by creation date, with the most recently created estimate item categories appearing first.

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

Link to documentation

hrvst estimates item-categories list
OptionDescriptionRequired
--updated_sinceOnly return estimate item categories 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

Retrieve a specific estimate item category

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

Link to documentation

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

Create an estimate item category

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

Link to documentation

hrvst estimates item-categories create
OptionDescriptionRequired
--nameThe name of the estimate item category.true
--fieldsComma separated list of fields to display in the output.false
--outputThe output format: json, tablefalse

Update an estimate item category

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

Link to documentation

hrvst estimates item-categories update
OptionDescriptionRequired
--estimate_item_category_idThe ID of the estimate item category you're updating.true
--nameThe name of the estimate item category.true
--fieldsComma separated list of fields to display in the output.false
--outputThe output format: json, tablefalse

Delete an estimate item category

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

Link to documentation

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