email Contact Us
  1. Harvest API V2 Documentation
  2. Estimates API
  3. Estimate Item Categories

Estimate Item Categories

Admin permissions required.

The estimate item category object

Attribute Type Description
id integer Unique ID for the estimate item category.
name string The name of the estimate item category.
created_at datetime Date and time the estimate item category was created.
updated_at datetime Date and time the estimate item category was last updated.

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.

GET /v2/estimate_item_categories
Parameter Type Description
updated_since datetime Only return estimate item categories that have been updated since the given date and time.
page integer DEPRECATED The page number to use in pagination. For instance, if you make a list request and receive 2000 records, your subsequent call can include page=2 to retrieve the next page of the list. (Default: 1)
per_page integer The number of records to return per page. Can range between 1 and 2000. (Default: 2000)
This endpoint supports cursor-based pagination and therefore deprecates the page parameter. For more information, visit the pagination guide.

Example Request:

curl "https://api.harvestapp.com/v2/estimate_item_categories" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Harvest-Account-Id: $ACCOUNT_ID" \
  -H "User-Agent: MyApp ([email protected])"

Example Response:

{
  "estimate_item_categories":[
    {
      "id":1378704,
      "name":"Product",
      "created_at":"2017-06-26T20:41:00Z",
      "updated_at":"2017-06-26T20:41:00Z"
    },
    {
      "id":1378703,
      "name":"Service",
      "created_at":"2017-06-26T20:41:00Z",
      "updated_at":"2017-06-26T20:41:00Z"
    }
  ],
  "per_page":2000,
  "total_pages":1,
  "total_entries":2,
  "next_page":null,
  "previous_page":null,
  "page":1,
  "links":{
    "first":"https://api.harvestapp.com/v2/estimate_item_categories?page=1&per_page=2000",
    "next":null,
    "previous":null,
    "last":"https://api.harvestapp.com/v2/estimate_item_categories?page=1&per_page=2000"
  }
}

Retrieve an 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.

GET /v2/estimate_item_categories/{ESTIMATE_ITEM_CATEGORY_ID}

Example Request:

curl "https://api.harvestapp.com/v2/estimate_item_categories/1378704" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Harvest-Account-Id: $ACCOUNT_ID" \
  -H "User-Agent: MyApp ([email protected])"

Example Response:

{
  "id":1378704,
  "name":"Product",
  "created_at":"2017-06-26T20:41:00Z",
  "updated_at":"2017-06-26T20:41:00Z"
}

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.

POST /v2/estimate_item_categories
Parameter Type Required Description
name string required The name of the estimate item category.

Example Request:

curl "https://api.harvestapp.com/v2/estimate_item_categories" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Harvest-Account-Id: $ACCOUNT_ID" \
  -H "User-Agent: MyApp ([email protected])" \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"name":"Hosting"}'

Example Response:

{
  "id":1379244,
  "name":"Hosting",
  "created_at":"2017-06-27T16:06:35Z",
  "updated_at":"2017-06-27T16:06:35Z"
}

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.

PATCH /v2/estimate_item_categories/{ESTIMATE_ITEM_CATEGORY_ID}
Parameter Type Description
name string The name of the estimate item category.

Example Request:

curl "https://api.harvestapp.com/v2/estimate_item_categories/1379244" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Harvest-Account-Id: $ACCOUNT_ID" \
  -H "User-Agent: MyApp ([email protected])" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"name":"Transportation"}'

Example Response:

{
  "id":1379244,
  "name":"Transportation",
  "created_at":"2017-06-27T16:06:35Z",
  "updated_at":"2017-06-27T16:07:05Z"
}

Delete an estimate item category

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

DELETE /v2/estimate_item_categories/{ESTIMATE_ITEM_CATEGORY_ID}

Example Request:

curl "https://api.harvestapp.com/v2/estimate_item_categories/1379244" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Harvest-Account-Id: $ACCOUNT_ID" \
  -H "User-Agent: MyApp ([email protected])" \
  -X DELETE

Still have questions? We’re happy to help!

Contact Us